Hlix Logs API

The logs API from Hlix — 6 operation(s) for logs.

GitHub OpenAPI

Operations 6

GET /v1/api/logs/agent-run/{agentRunId} List the log lines of one agent run #
GET /v1/api/logs/agent/{agentId} List the log lines across one agent's tasks #
GET /v1/api/logs/cycle/{cycleId} List one cycle's log lines #
GET /v1/api/logs/project/{projectId} List a project's log lines #
GET /v1/api/logs/task/{taskId} List one task's log lines #
GET /v1/api/logs/trace/{traceId} List the log lines of one trace #

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-logs-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.

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

OpenAPI Specification

hlix-ai-logs-api-openapi.yml Raw ↑
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 Logs API
  version: 1.0.0
servers:
- url: https://server.hlix.ai
  description: API server
security:
- apiKey: []
- sessionCookie: []
tags:
- name: Logs
paths:
  /v1/api/logs/agent-run/{agentRunId}:
    get:
      operationId: listAgentRunLogs
      parameters:
      - in: path
        name: agentRunId
        required: true
        schema:
          type: string
      - description: Page size, clamped to 1–2000; 500 when `before` or `after` is given without it. With none of `limit`, `before` and `after`, the newest 2000 lines are returned (page back with `before`).
        in: query
        name: limit
        required: false
        schema:
          type: string
      - description: 'A log line id: the page of lines just before it. Without `before` or `after`, a page is the newest lines. Every page is oldest first; ask again with the page''s first id until a page comes back shorter than `limit`.'
        in: query
        name: before
        required: false
        schema:
          type: string
      - description: 'A log line id: the lines after it, oldest first. Ask again with the page''s last id until a page comes back shorter than `limit`.'
        in: query
        name: after
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LogEntry'
                type: array
          description: Every line one run produced.
        '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 log lines of one agent run
      tags:
      - Logs
  /v1/api/logs/agent/{agentId}:
    get:
      operationId: listAgentLogs
      parameters:
      - in: path
        name: agentId
        required: true
        schema:
          type: string
      - description: Page size, clamped to 1–2000; 500 when `before` or `after` is given without it. With none of `limit`, `before` and `after`, the newest 2000 lines are returned (page back with `before`).
        in: query
        name: limit
        required: false
        schema:
          type: string
      - description: 'A log line id: the page of lines just before it. Without `before` or `after`, a page is the newest lines. Every page is oldest first; ask again with the page''s first id until a page comes back shorter than `limit`.'
        in: query
        name: before
        required: false
        schema:
          type: string
      - description: 'A log line id: the lines after it, oldest first. Ask again with the page''s last id until a page comes back shorter than `limit`.'
        in: query
        name: after
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LogEntry'
                type: array
          description: Lines from every task assigned to this agent, oldest first. Reached through `tasks.agentId`.
        '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 log lines across one agent's tasks
      tags:
      - Logs
  /v1/api/logs/cycle/{cycleId}:
    get:
      operationId: listCycleLogs
      parameters:
      - in: path
        name: cycleId
        required: true
        schema:
          type: string
      - description: Page size, clamped to 1–2000; 500 when `before` or `after` is given without it. With none of `limit`, `before` and `after`, the newest 2000 lines are returned (page back with `before`).
        in: query
        name: limit
        required: false
        schema:
          type: string
      - description: 'A log line id: the page of lines just before it. Without `before` or `after`, a page is the newest lines. Every page is oldest first; ask again with the page''s first id until a page comes back shorter than `limit`.'
        in: query
        name: before
        required: false
        schema:
          type: string
      - description: 'A log line id: the lines after it, oldest first. Ask again with the page''s last id until a page comes back shorter than `limit`.'
        in: query
        name: after
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LogEntry'
                type: array
          description: Every line recorded against the cycle itself.
        '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 cycle's log lines
      tags:
      - Logs
  /v1/api/logs/project/{projectId}:
    get:
      operationId: listProjectLogs
      parameters:
      - in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: Page size, clamped to 1–2000; 500 when `before` or `after` is given without it. With none of `limit`, `before` and `after`, the newest 2000 lines are returned (page back with `before`).
        in: query
        name: limit
        required: false
        schema:
          type: string
      - description: 'A log line id: the page of lines just before it. Without `before` or `after`, a page is the newest lines. Every page is oldest first; ask again with the page''s first id until a page comes back shorter than `limit`.'
        in: query
        name: before
        required: false
        schema:
          type: string
      - description: 'A log line id: the lines after it, oldest first. Ask again with the page''s last id until a page comes back shorter than `limit`.'
        in: query
        name: after
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LogEntry'
                type: array
          description: Lines from every cycle of the project, oldest first. A line with no cycle is not reachable this way.
        '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 a project's log lines
      tags:
      - Logs
  /v1/api/logs/task/{taskId}:
    get:
      operationId: listTaskLogs
      parameters:
      - in: path
        name: taskId
        required: true
        schema:
          type: string
      - description: Page size, clamped to 1–2000; 500 when `before` or `after` is given without it. With none of `limit`, `before` and `after`, the newest 2000 lines are returned (page back with `before`).
        in: query
        name: limit
        required: false
        schema:
          type: string
      - description: 'A log line id: the page of lines just before it. Without `before` or `after`, a page is the newest lines. Every page is oldest first; ask again with the page''s first id until a page comes back shorter than `limit`.'
        in: query
        name: before
        required: false
        schema:
          type: string
      - description: 'A log line id: the lines after it, oldest first. Ask again with the page''s last id until a page comes back shorter than `limit`.'
        in: query
        name: after
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LogEntry'
                type: array
          description: Every line recorded against the task.
        '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 log lines
      tags:
      - Logs
  /v1/api/logs/trace/{traceId}:
    get:
      operationId: listTraceLogs
      parameters:
      - in: path
        name: traceId
        required: true
        schema:
          type: string
      - description: Page size, clamped to 1–2000; 500 when `before` or `after` is given without it. With none of `limit`, `before` and `after`, the newest 2000 lines are returned (page back with `before`).
        in: query
        name: limit
        required: false
        schema:
          type: string
      - description: 'A log line id: the page of lines just before it. Without `before` or `after`, a page is the newest lines. Every page is oldest first; ask again with the page''s first id until a page comes back shorter than `limit`.'
        in: query
        name: before
        required: false
        schema:
          type: string
      - description: 'A log line id: the lines after it, oldest first. Ask again with the page''s last id until a page comes back shorter than `limit`.'
        in: query
        name: after
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LogEntry'
                type: array
          description: Every line sharing this trace id — the same correlation the run, event and audit rows carry.
        '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 log lines of one trace
      tags:
      - Logs
components:
  schemas:
    ApiError:
      additionalProperties: {}
      properties:
        error:
          type: string
      required:
      - error
      type: object
    LogEntry:
      properties:
        agentRunId:
          type:
          - string
          - 'null'
        createdAt:
          type: string
        cycleId:
          type:
          - string
          - 'null'
        id:
          type: string
        level:
          enum:
          - debug
          - info
          - warn
          - error
          type: string
        message:
          type: string
        organizationId:
          type: string
        spanId:
          type:
          - string
          - 'null'
        taskId:
          type:
          - string
          - 'null'
        traceId:
          type:
          - string
          - 'null'
      required:
      - id
      - organizationId
      - taskId
      - cycleId
      - agentRunId
      - traceId
      - spanId
      - level
      - message
      - createdAt
      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