Get a Run - Exa

Get a Run

curl --request GET \
  --url https://api.exa.ai/monitors/{id}/runs/{runId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.exa.ai/monitors/{id}/runs/{runId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "monitorId": "<string>",
  "status": "pending",
  "output": {
    "results": [
      {}
    ],
    "content": true,
    "grounding": [
      {
        "field": "<string>",
        "citations": [
          {
            "url": "<string>",
            "title": "<string>"
          }
        ],
        "confidence": "low"
      }
    ]
  },
  "failReason": "api_key_invalid",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "durationMs": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "requestId": "0a1b2c3d4e5f60718293a4b5c6d7e8f9",
  "error": "Invalid request body: query: Invalid input: expected string, received undefined",
  "tag": "INVALID_REQUEST_BODY"
}

{
  "requestId": "f2a4c6e8b0d2f4a6c8e0b2d4f6a8c0e2",
  "error": "Invalid API key",
  "tag": "INVALID_API_KEY"
}

{
  "requestId": "3b1d5f7a9c0e2b4d6f8a0c2e4b6d8f0a",
  "error": "Not found",
  "tag": "NOT_FOUND"
}

{
  "requestId": "9b1d3f5e7a0c2e4b6d8f0a2c4e6b8d0f",
  "error": "Sorry, we encountered an error while processing your request. Please try again later",
  "tag": "DEFAULT_ERROR"
}

GET

/

monitors

/

{id}

/

runs

/

{runId}

Get a Run

curl --request GET \
  --url https://api.exa.ai/monitors/{id}/runs/{runId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.exa.ai/monitors/{id}/runs/{runId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "monitorId": "<string>",
  "status": "pending",
  "output": {
    "results": [
      {}
    ],
    "content": true,
    "grounding": [
      {
        "field": "<string>",
        "citations": [
          {
            "url": "<string>",
            "title": "<string>"
          }
        ],
        "confidence": "low"
      }
    ]
  },
  "failReason": "api_key_invalid",
  "startedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "durationMs": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "requestId": "0a1b2c3d4e5f60718293a4b5c6d7e8f9",
  "error": "Invalid request body: query: Invalid input: expected string, received undefined",
  "tag": "INVALID_REQUEST_BODY"
}

{
  "requestId": "f2a4c6e8b0d2f4a6c8e0b2d4f6a8c0e2",
  "error": "Invalid API key",
  "tag": "INVALID_API_KEY"
}

{
  "requestId": "3b1d5f7a9c0e2b4d6f8a0c2e4b6d8f0a",
  "error": "Not found",
  "tag": "NOT_FOUND"
}

{
  "requestId": "9b1d3f5e7a0c2e4b6d8f0a2c4e6b8d0f",
  "error": "Sorry, we encountered an error while processing your request. Please try again later",
  "tag": "DEFAULT_ERROR"
}

Authorizations

x-api-key

string

header

required

Pass your Exa API key in the x-api-key header. You can also authenticate with Authorization: Bearer .

Path Parameters

id

string

required

The monitor ID

runId

string

required

The run ID

Response

The run

id

string

required

The unique identifier for the run

monitorId

string

required

The monitor this run belongs to

status

enum<string>

required

The status of the run

Available options:

pending,

running,

completed,

failed,

cancelled

output

object | null

required

The output of the run. Null until the run completes.

Show child attributes

failReason

enum<string> | null

required

The reason the run failed. Null unless status is failed. source_not_available means the search requested a domain Exa cannot return (remove it from the search), and forbidden means the request was otherwise not permitted.

Available options:

api_key_invalid,

insufficient_credits,

invalid_params,

rate_limited,

source_not_available,

forbidden,

search_unavailable,

search_failed,

internal_error

startedAt

string<date-time>

required

When the run started executing

completedAt

string<date-time>

required

When the run completed successfully

failedAt

string<date-time>

required

When the run failed

cancelledAt

string<date-time>

required

When the run was cancelled

durationMs

integer | null

required

Total execution time in milliseconds

createdAt

string<date-time>

required

When the run was created

updatedAt

string<date-time>

required

When the run was last updated