ParagraphDocs
Open the app
GuidesDevelopers

Get an agent run

GET
/v1/agents/{agentKey}/runs/{runId}

Reports where a run has got to, and the drafts it has produced.

Authorization

apiKey
headerAuthorizationBearer <token>

API key for authenticating protected endpoints. Pass as Bearer token in Authorization header.

Path Parameters

agentKey*string

Which agent, such as changelog

runId*string

The run to read

Response Body

Run details

application/json
  1. response
runId*string
status*string

Where the run has got to

Value in"queued""running""succeeded""completed_with_warnings""failed""blocked""canceled"
startedAt*|

When the run began, ISO 8601

finishedAt*|

When it ended, ISO 8601

deliverables*array<>

The drafts this run has produced so far

curl -X GET "https://example.com/v1/agents/string/runs/string"
{  "runId": "string",  "status": "queued",  "startedAt": "string",  "finishedAt": "string",  "deliverables": [    {      "export": "string",      "item": "string",      "status": "string"    }  ]}

Start an agent run POST

Starts a run of an agent your publication has already set up, and returns straight away. A run takes several minutes, so poll `GET /v1/agents/{agentKey}/runs/{runId}` for the drafts. Nothing publishes: a run produces drafts for someone to review in the app.

Get authenticated publication GET

Returns the publication associated with the API key used in the request. Useful for verifying your API key and retrieving your publication details.