Agent endpoints

Generated from the central API contract. Availability and permissions are checked by the connected service.

GET /v1/agent/conversations

Listing

Authorization: projects:read Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Parameter

Location

Required

Type / values

project_id

query

Yes

string (uuid)

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X GET \
  -H "Authorization: Bearer $GD_API_KEY" \
  "$GD_API_BASE/v1/agent/conversations?project_id=REPLACE_PROJECT_ID"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.

POST /v1/agent/conversations

Create

Authorization: projects:read Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Request body: application/json — Create. Required.

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X POST \
  -H "Authorization: Bearer $GD_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  "$GD_API_BASE/v1/agent/conversations"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.

GET /v1/agent/conversations/{identity}

Read

Authorization: projects:read Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Parameter

Location

Required

Type / values

identity

path

Yes

string (uuid)

before

query

No

string (uuid) or null

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X GET \
  -H "Authorization: Bearer $GD_API_KEY" \
  "$GD_API_BASE/v1/agent/conversations/REPLACE_IDENTITY"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.

POST /v1/agent/conversations/{identity}/messages

Message

Authorization: projects:read Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Parameter

Location

Required

Type / values

identity

path

Yes

string (uuid)

Request body: application/json — Message. Required.

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X POST \
  -H "Authorization: Bearer $GD_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  "$GD_API_BASE/v1/agent/conversations/REPLACE_IDENTITY/messages"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.

POST /v1/agent/conversations/{identity}/turns/{turn_id}/run

Run

Authorization: projects:read Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Parameter

Location

Required

Type / values

identity

path

Yes

string (uuid)

turn_id

path

Yes

string (uuid)

Request body: application/json — Generation. Required.

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X POST \
  -H "Authorization: Bearer $GD_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  "$GD_API_BASE/v1/agent/conversations/REPLACE_IDENTITY/turns/REPLACE_TURN_ID/run"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.

POST /v1/agent/conversations/{identity}/decision

Decision

Authorization: projects:read Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Parameter

Location

Required

Type / values

identity

path

Yes

string (uuid)

Request body: application/json — Decision. Required.

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X POST \
  -H "Authorization: Bearer $GD_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  "$GD_API_BASE/v1/agent/conversations/REPLACE_IDENTITY/decision"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.

POST /v1/agent/conversations/{identity}/stop

Stop

Authorization: projects:read Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Parameter

Location

Required

Type / values

identity

path

Yes

string (uuid)

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X POST \
  -H "Authorization: Bearer $GD_API_KEY" \
  "$GD_API_BASE/v1/agent/conversations/REPLACE_IDENTITY/stop"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.

POST /v1/agent/conversations/{identity}/draft/clear

Clear

Authorization: projects:read Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Parameter

Location

Required

Type / values

identity

path

Yes

string (uuid)

Request body: application/json — DraftDecision. Required.

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X POST \
  -H "Authorization: Bearer $GD_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  "$GD_API_BASE/v1/agent/conversations/REPLACE_IDENTITY/draft/clear"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.