[]
reArray
Documentation

Integration API

Trigger task executions, list runs, and receive webhook callbacks programmatically.

The Integration API lets external systems queue task executions, inspect run status, fetch artifacts, and receive signed webhook callbacks when runs progress.

Base URL

All endpoints are under:

https://your-app.example.com/api/v1/integrations

Replace your-app.example.com with your reArray deployment hostname.

Authentication

Authenticate every request with a Bearer API key:

Authorization: Bearer ra_live_<prefix>_<secret>

API keys are created in the workspace Integrations page. See Authentication for key management and scoping.

OpenAPI specification

Fetch the machine-readable spec:

GET /api/v1/integrations/openapi.json

No authentication required. The spec describes all endpoints, request/response schemas, and error codes.

Endpoints overview

MethodPathPurpose
POST/executionsQueue an execution
GET/executionsList executions (cursor pagination)
GET/executions/{id}Get execution by ID (status, result, file artifacts)
POST/executions/{id}/cancelCancel an execution
GET/executions/{id}/artifactsSigned video URLs and file artifact links
GET/executions/{id}/files/{fileId}Download one file artifact (302 to signed URL)
GET/tasksList runnable tasks
GET/tasks/{id}Get task details
GET/tasks/{id}/params-schemaGet params schema for a version
GET/agentsList available agents
POST/webhooks/testSend a test webhook

Error responses

Errors return JSON with a consistent shape:

{
  "error": {
    "code": "invalid_request",
    "message": "Human-readable description",
    "details": null,
    "request_id": "req_..."
  }
}

Common error codes: invalid_request, unauthorized, forbidden, not_found, rate_limited, invalid_params, idempotency_conflict, concurrency_limit_reached, internal_error.

In this section