find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hlix-ai:hlix-ai-agent-runs-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: Explore the Hlix API for projects, agent teams, and delivery workflows. Authenticate with `x-api-key` and select a Workspace with `X-Organization-Id`. Session-only operations require a signed-in user session. Authentication setup.
  title: reference Agent Runs API
  version: 1.0.0
servers:
- url: https://server.hlix.ai
  description: API server
security:
- apiKey: []
- sessionCookie: []
tags:
- name: Agent Runs
paths:
  /v1/api/agent-runs/cycle/{cycleId}:
    get:
      operationId: listCycleAgentRuns
      parameters:
      - in: path
        name: cycleId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AgentRunSummary'
                type: array
          description: Cost and timing per run, start-ordered. Snapshots are not included.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: List the runs of every task in a cycle
      tags:
      - Agent Runs
  /v1/api/agent-runs/project/{projectId}:
    get:
      operationId: listProjectAgentRuns
      parameters:
      - in: path
        name: projectId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AgentRunSummary'
                type: array
          description: Task-execution runs plus the planning and chat runs attributed to the project directly.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: List every run of a project
      tags:
      - Agent Runs
  /v1/api/agent-runs/task/{taskId}:
    get:
      operationId: listTaskAgentRuns
      parameters:
      - in: path
        name: taskId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AgentRun'
                type: array
          description: Every run on the task, whole rows. Empty when the task never ran.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: List the runs recorded against one task
      tags:
      - Agent Runs
  /v1/api/agent-runs/task/{taskId}/timeline:
    get:
      operationId: listTaskAgentRunTimeline
      parameters:
      - in: path
        name: taskId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AgentRun'
                type: array
          description: The same rows as the task list, ordered oldest-first by start time.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The resource does not exist, or the caller is a task-scoped credential and this endpoint is outside its allowlist.
      summary: List one task's runs in start order
      tags:
      - Agent Runs
  /v1/api/agent-runs/{id}/snapshot:
    get:
      operationId: getAgentRunSnapshot
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRunSnapshot'
          description: The run, with the text its harness recorded.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The request named no active organization.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No valid session or API key.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Authenticated, but not a member of the named organization — or a client collaborator without the required access on this project.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No such run in this workspace.
      summary: Get one run's recorded input and output
      tags:
      - Agent Runs
components:
  schemas:
    ApiError:
      additionalProperties: {}
      properties:
        error:
          type: string
      required:
      - error
      type: object
    AgentRun:
      properties:
        accountingSource:
          anyOf:
          - enum:
            - proxy
            - driver
            type: string
          - type: 'null'
        billedTo:
          anyOf:
          - enum:
            - workspace_key
            - hlix
            type: string
          - type: 'null'
        billingMarkupBps:
          anyOf:
          - maximum: 9007199254740991
            minimum: -9007199254740991
            type: integer
          - type: 'null'
        billingProjectKind:
          type:
          - string
          - 'null'
        coderAccountId:
          type:
          - string
          - 'null'
        completedAt:
          type:
          - string
          - 'null'
        costMicros:
          anyOf:
          - format: int64
            maximum: 9007199254740991
            minimum: -9007199254740991
            type: integer
          - type: 'null'
        credentialKind:
          anyOf:
          - enum:
            - api_key
            - subscription
            type: string
          - type: 'null'
        cycleId:
          type:
          - string
          - 'null'
        cycleRunId:
          type:
          - string
          - 'null'
        durableRunId:
          type:
          - string
          - 'null'
        fundingMode:
          anyOf:
          - enum:
            - managed
            - api_key
            - subscription
            type: string
          - type: 'null'
        id:
          type: string
        inputSnapshot:
          type:
          - string
          - 'null'
        iteration:
          anyOf:
          - maximum: 9007199254740991
            minimum: -9007199254740991
            type: integer
          - type: 'null'
        model:
          type: string
        organizationId:
          type: string
        outputSnapshot:
          type:
          - string
          - 'null'
        parentRunId:
          type:
          - string
          - 'null'
        persona:
          type:
          - string
          - 'null'
        projectId:
          type:
          - string
          - 'null'
        role:
          enum:
          - planner
          - builder
          - tester
          - reviewer
          - intake
          type: string
        spanId:
          type:
          - string
          - 'null'
        startedAt:
          type: string
        status:
          enum:
          - running
          - completed
          - failed
          type: string
        taskId:
          type:
          - string
          - 'null'
        tokensIn:
          anyOf:
          - maximum: 9007199254740991
            minimum: -9007199254740991
            type: integer
          - type: 'null'
        tokensOut:
          anyOf:
          - maximum: 9007199254740991
            minimum: -9007199254740991
            type: integer
          - type: 'null'
        traceId:
          type:
          - string
          - 'null'
        usageCompleteness:
          anyOf:
          - enum:
            - unknown
            - partial
            - complete
            type: string
          - type: 'null'
        usageSequence:
          anyOf:
          - maximum: 9007199254740991
            minimum: -9007199254740991
            type: integer
          - type: 'null'
      required:
      - id
      - organizationId
      - taskId
      - projectId
      - billingProjectKind
      - billingMarkupBps
      - cycleId
      - role
      - model
      - status
      - tokensIn
      - tokensOut
      - costMicros
      - inputSnapshot
      - outputSnapshot
      - parentRunId
      - persona
      - iteration
      - traceId
      - spanId
      - durableRunId
      - cycleRunId
      - billedTo
      - fundingMode
      - coderAccountId
      - credentialKind
      - accountingSource
      - usageCompleteness
      - usageSequence
      - startedAt
      - completedAt
      type: object
    AgentRunSnapshot:
      properties:
        completedAt:
          type:
          - string
          - 'null'
        id:
          type: string
        inputSnapshot:
          type:
          - string
          - 'null'
        model:
          type: string
        outputSnapshot:
          type:
          - string
          - 'null'
        parentRunId:
          type:
          - string
          - 'null'
        persona:
          type:
          - string
          - 'null'
        role:
          enum:
          - planner
          - builder
          - tester
          - reviewer
          - intake
          type: string
        startedAt:
          type: string
        status:
          enum:
          - running
          - completed
          - failed
          type: string
        taskId:
          type:
          - string
          - 'null'
      required:
      - id
      - taskId
      - role
      - persona
      - model
      - status
      - inputSnapshot
      - outputSnapshot
      - parentRunId
      - startedAt
      - completedAt
      type: object
    AgentRunSummary:
      properties:
        accountingSource:
          anyOf:
          - enum:
            - proxy
            - driver
            type: string
          - type: 'null'
        billedTo:
          anyOf:
          - enum:
            - workspace_key
            - hlix
            type: string
          - type: 'null'
        coderAccountId:
          type:
          - string
          - 'null'
        completedAt:
          type:
          - string
          - 'null'
        costMicros:
          anyOf:
          - format: int64
            maximum: 9007199254740991
            minimum: -9007199254740991
            type: integer
          - type: 'null'
        credentialKind:
          anyOf:
          - enum:
            - api_key
            - subscription
            type: string
          - type: 'null'
        fundingMode:
          anyOf:
          - enum:
            - managed
            - api_key
            - subscription
            type: string
          - type: 'null'
        id:
          type: string
        model:
          type: string
        persona:
          type:
          - string
          - 'null'
        role:
          enum:
          - planner
          - builder
          - tester
          - reviewer
          - intake
          type: string
        startedAt:
          type: string
        status:
          enum:
          - running
          - completed
          - failed
          type: string
        taskId:
          type:
          - string
          - 'null'
        tokensIn:
          anyOf:
          - maximum: 9007199254740991
            minimum: -9007199254740991
            type: integer
          - type: 'null'
        tokensOut:
          anyOf:
          - maximum: 9007199254740991
            minimum: -9007199254740991
            type: integer
          - type: 'null'
        usageCompleteness:
          anyOf:
          - enum:
            - unknown
            - partial
            - complete
            type: string
          - type: 'null'
      required:
      - id
      - taskId
      - role
      - persona
      - model
      - status
      - tokensIn
      - tokensOut
      - costMicros
      - billedTo
      - fundingMode
      - coderAccountId
      - credentialKind
      - accountingSource
      - usageCompleteness
      - startedAt
      - completedAt
      type: object
  parameters:
    OrganizationId:
      description: The workspace (organization) to act in. Omitted, the session's active organization is used.
      in: header
      name: X-Organization-Id
      required: false
      schema:
        type: string
      example: YOUR_WORKSPACE_ID
  securitySchemes:
    apiKey:
      description: An API key issued through `/v1/api/auth/api-key/*`. Browser clients can use their session cookie instead.
      in: header
      name: x-api-key
      type: apiKey
    sessionCookie:
      description: The complete session Cookie header issued by sign-in at the selected API host. Cookie names vary by hosting region and environment; preserve the issued name and value. Browsers send these HTTP-only cookies automatically. Session-only operations require this user session and do not accept an API key.
      in: header
      name: Cookie
      type: apiKey