Fetch the status of an agent response

GET https://app.credal.ai/api/v1/agents/fetchAgentResponse

Polls for the status and result of a previously sent agent message using the job ID returned by sendMessage. Requires the api:agent:message:* scope.

Reference: https://docs.credal.ai/api-reference/v-1/api-reference/agents/fetch-response

• Authorization header (bearer token, required) — Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

• jobId (string, required)

200

Agent response status

• agents_fetchResponse_Response_200

Invalid request

• any

Unauthorized

• any

Forbidden

• any

Job not found

• any

Internal server error

• any

Types

AgentsFetchResponseResponse2000

• status (enum, required)
  • Allowed values: RUNNING

AgentsFetchResponseResponse2001

• status (enum, required)
  • Allowed values: COMPLETED
• result (AgentsFetchAgentResponseGetResponsesContentApplicationJsonSchemaOneOf1Result, required)

AgentsFetchResponseResponse2002

• status (enum, required)
  • Allowed values: FAILED
• errorMessage (string, required)

AgentsFetchAgentResponseGetResponsesContentApplicationJsonSchemaOneOf1Result

• agentResponseText (string, required)

Examples

Response

{
  "status": "COMPLETED",
  "result": {
    "agentResponseText": "Here are the Q4 planning documents I found..."
  }
}