> ## Documentation Index > Fetch the complete documentation index at: https://evalgate.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create workflows runs > Requires scopes: runs:write ## OpenAPI ````yaml /api-reference/openapi.json post /api/workflows/{id}/runs openapi: 3.1.2 info: title: EvalGate API version: 18.13.0 description: EvalGate API. See docs/api-contract.md for stability commitments. servers: - url: https://evalgate.com description: Production - url: http://localhost:3000 description: Local security: [] paths: /api/workflows/{id}/runs: post: tags: - workflows summary: Create workflows runs description: 'Requires scopes: runs:write' operationId: post_workflows_id_runs parameters: - name: id in: path required: true schema: type: integer requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiWorkflowsIdRunsRequest' responses: '201': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/PostApiWorkflowsIdRunsResponse201ApplicationJson '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' '503': $ref: '#/components/responses/ServiceUnavailable' security: - bearerAuth: [] components: schemas: PostApiWorkflowsIdRunsRequest: type: object properties: traceId: type: number metadata: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' input: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' additionalProperties: false required: - traceId PostApiWorkflowsIdRunsResponse201ApplicationJson: type: object properties: status: type: string id: type: number organizationId: $ref: '#/components/schemas/OrganizationId' metadata: oneOf: - type: 'null' - type: object properties: trigger: type: string environment: type: string evaluationId: type: number autonomyLevel: oneOf: - type: string enum: - manual - type: string enum: - default_approvals - type: string enum: - bypass_approvals - type: string enum: - autopilot approvalMode: type: string hookCount: type: number checkpointed: oneOf: - type: boolean enum: - false - type: boolean enum: - true agentWorkflowType: type: string sessionId: type: string workflowProfile: oneOf: - type: 'null' - type: object properties: recipeTitle: type: string workflowClass: oneOf: - type: string enum: - approval_gated_mutation - type: string enum: - background_execution - type: string enum: - recovery_required - type: string enum: - policy_conflict - type: string enum: - handoff_heavy - type: string enum: - memory_sensitive - type: string enum: - parallel_tool_use autonomyLevel: oneOf: - type: string enum: - manual - type: string enum: - default_approvals - type: string enum: - bypass_approvals - type: string enum: - autopilot approvalMode: oneOf: - type: string enum: - none - type: string enum: - human_review - type: string enum: - policy_guided - type: string enum: - auto_with_audit memoryMode: oneOf: - type: string enum: - none - type: string enum: - session - type: string enum: - mixed - type: string enum: - persistent backgroundExecution: type: boolean requiredHooks: type: array items: oneOf: - type: string enum: - session_start - type: string enum: - pre_plan - type: string enum: - pre_tool - type: string enum: - post_tool - type: string enum: - pre_write - type: string enum: - pre_handoff - type: string enum: - on_error - type: string enum: - session_end linkedFailureModes: type: array items: type: string successMetrics: type: array items: type: string guardrails: type: array items: type: string recommendedIterations: type: number source: oneOf: - type: string enum: - coverage_gap - type: string enum: - failure additionalProperties: false required: - recipeTitle - workflowClass - autonomyLevel - approvalMode - memoryMode - backgroundExecution - requiredHooks - linkedFailureModes - successMetrics - guardrails - recommendedIterations - source hookInvocations: type: array items: type: object properties: hook: oneOf: - type: string enum: - session_start - type: string enum: - pre_plan - type: string enum: - pre_tool - type: string enum: - post_tool - type: string enum: - pre_write - type: string enum: - pre_handoff - type: string enum: - on_error - type: string enum: - session_end blocked: type: boolean latencyMs: type: number detail: type: string additionalProperties: false required: - hook - blocked - latencyMs - detail approvalDecisions: type: array items: type: object properties: actionType: type: string riskLevel: oneOf: - type: string enum: - medium - type: string enum: - high - type: string enum: - critical - type: string enum: - low recommendedDisposition: oneOf: - type: string enum: - deny - type: string enum: - auto_approve - type: string enum: - require_review finalDisposition: oneOf: - type: string enum: - rejected - type: string enum: - approved - type: string enum: - overridden rationale: type: string additionalProperties: false required: - actionType - riskLevel - recommendedDisposition - finalDisposition - rationale memoryEvents: type: array items: type: object properties: layer: oneOf: - type: string enum: - session - type: string enum: - project_rule - type: string enum: - persistent_memory operation: oneOf: - type: string enum: - read - type: string enum: - write - type: string enum: - ignore sourceId: type: string detail: type: string additionalProperties: false required: - layer - operation - sourceId - detail checkpoints: type: array items: type: object properties: kind: oneOf: - type: string enum: - manual - type: string enum: - auto restorable: type: boolean label: type: string additionalProperties: false required: - kind - restorable - label debugSnapshots: type: array items: type: object properties: stepIndex: type: number label: type: string activeHooks: type: array items: oneOf: - type: string enum: - session_start - type: string enum: - pre_plan - type: string enum: - pre_tool - type: string enum: - post_tool - type: string enum: - pre_write - type: string enum: - pre_handoff - type: string enum: - on_error - type: string enum: - session_end memoryRefs: type: array items: type: string approvalState: type: string summary: type: string additionalProperties: false required: - stepIndex - label - activeHooks - memoryRefs - approvalState - summary runtimeSummary: oneOf: - type: 'null' - type: object properties: workflowRunId: type: number traceId: type: number executionMode: oneOf: - type: string enum: - analysis_only - type: string enum: - single_agent - type: string enum: - parallel_swarm finalStatus: oneOf: - type: string enum: - completed - type: string enum: - failed stopReason: oneOf: - type: 'null' - type: string approvalState: type: string hookCount: type: number memoryReadCount: type: number checkpointCreated: type: boolean handoffCount: type: number debugSnapshotCount: type: number decisionCount: type: number additionalProperties: false required: - executionMode - finalStatus - stopReason - approvalState - hookCount - memoryReadCount - checkpointCreated - handoffCount - debugSnapshotCount - decisionCount additionalProperties: false startedAt: type: string format: date-time completedAt: oneOf: - type: 'null' - type: string format: date-time traceId: type: number input: oneOf: - type: 'null' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' output: oneOf: - type: 'null' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' workflowId: oneOf: - type: 'null' - type: number totalCost: oneOf: - type: 'null' - type: string totalDurationMs: oneOf: - type: 'null' - type: number agentCount: oneOf: - type: 'null' - type: number handoffCount: oneOf: - type: 'null' - type: number retryCount: oneOf: - type: 'null' - type: number errorMessage: oneOf: - type: 'null' - type: string trigger: oneOf: - type: 'null' - type: string additionalProperties: false required: - status - id - organizationId - metadata - startedAt - completedAt - traceId - input - output - workflowId - totalCost - totalDurationMs - agentCount - handoffCount - retryCount - errorMessage - trigger JsonValue: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' OrganizationId: type: string format: uuid ApiError: type: object properties: error: type: object properties: code: type: string enum: - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - INVALID_REFERENCE - VALIDATION_ERROR - RATE_LIMITED - CONFLICT - INTERNAL_ERROR - SERVICE_UNAVAILABLE - QUOTA_EXCEEDED - FEATURE_LIMIT_REACHED - NO_ORG_MEMBERSHIP - SHARE_REVOKED - SHARE_EXPIRED - SHARE_UNAVAILABLE - PROVIDER_KEY_MISSING - PROVIDER_KEY_EXPIRED - PROVIDER_RATE_LIMITED - PROVIDER_UNAUTHORIZED - PROVIDER_UNAVAILABLE - AGENT_HANDOFF_INVALID - AGENT_HANDOFF_EXPIRED - AGENT_HANDOFF_DENIED - AGENT_HANDOFF_CONSUMED - PAYLOAD_TOO_LARGE - METHOD_NOT_ALLOWED message: type: string details: {} requestId: type: string format: uuid redaction: type: object properties: applied: type: boolean enum: - true fieldCount: type: integer minimum: 0 secretCount: type: integer minimum: 0 required: - applied - fieldCount - secretCount required: - code - message required: - error responses: ValidationError: description: Validation error content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string WWW-Authenticate: description: >- Bearer challenge. Agent-facing routes include the RFC 9728 resource_metadata URL. schema: type: string Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string Conflict: description: Conflict content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string RateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string Retry-After: description: Delay in seconds before retrying when present. schema: type: integer minimum: 1 InternalError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string ServiceUnavailable: description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: EvalGate API key description: >- Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes. x-evalgate-scopes-supported: - eval:read - eval:write - objectives:read - objectives:write - runs:read - runs:write - traces:read - traces:write - exports:download - reports:write - prompt:publish - scorer:publish - red_team:read - red_team:run - red_team:approve - docs:read - agent:read - agent:execute - resources:read - resources:write - contexts:read - contexts:write - observations:write - checks:read - checks:run - standards:read - standards:write - standards:approve - grants:read - grants:write - admin:keys - admin:workspace - admin:org x-evalgate-protected-resource-metadata: https://www.evalgate.com/.well-known/oauth-protected-resource ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.