Agent runs
Start an agent run
Starts a manual run asynchronously and returns the run. Send an Idempotency-Key header to make a retry safe. Credit enforcement returns 402; missing run permission returns 403.
posthttps://api.govdash.us/v1/agents/{id}/runs
Authorization
Your API key as a bearer token, for example Bearer gd_live_....
See Authentication for how to create a key.
Path parameters
Headers
Makes a retried request safe. Reuse the same key to retry; the original result is returned instead of repeating the action. Keys are kept for 60 minutes. 1 to 255 printable ASCII characters.
The dated API version this request is written against. Responses keep that version's shape after newer versions ship.
One of:
Body
application/jsonShow child attributesHide child attributes
Response
202 · application/jsonWhen the run was created.
Latest run start or completion time.
One of:
One of:
When the run started.
When the run completed.
Show child attributesHide child attributes
One of:
Errors
Every error returns a stable error.code to branch on and an error.message that says what went wrong, like the examples below. See Errors for how to handle each one.
A path or query parameter is malformed.
Invalid request path parameters: Expected a non-empty string
Your team has used up a quota this request needs, such as agent credits. The message says which.
The key's service account doesn't have the permission this needs, or your team's access has ended.
You do not have permission to perform this action.
The record doesn't exist, belongs to another team, or is above the key's classification.
The requested resource was not found.
A record like this already exists. Use it instead of creating another.
The request conflicts with an existing resource.
The request is well formed, but GovDash won't make this change. The message says why, when it can.
The request failed validation.
You sent too many requests. Wait the seconds in the retry-after header, then retry.
This access token exceeded its write rate limit.
Something went wrong on GovDash's side, usually a bug. Retry with backoff, and check before retrying a create.
An unexpected error occurred.
GovDash is briefly unavailable and didn't run the request. Retry after retry-after.
The service is temporarily unavailable. Try again later.