ParagraphDocs
Open the app
GuidesDevelopers

List recent runs

GET
/v1/agents/{agentKey}/runs

This agent's runs, newest first.

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

Query Parameters

limit?integer

How many to return, up to 50. Defaults to 10.

Range1 <= value <= 50

Response Body

Recent runs

application/json
  1. response
runs*array<>
curl -X GET "https://example.com/v1/agents/string/runs"
{  "runs": [    {      "runId": "string",      "status": "queued",      "startedAt": "string",      "finishedAt": "string",      "deliverables": [        {          "export": "string",          "item": "string",          "status": "string"        }      ]    }  ]}

Set an agent up PUT

Creates the agent's setup, or replaces it. This is a full replacement rather than a merge, so send every field you want kept. It changes the setup your team sees in the app, and the next run uses it.

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.