Relevance AI

Relevance AI Agent Runtime Events API

The Agent Runtime Events API from Relevance AI — 4 operation(s) for agent runtime events.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /agent-runtime-events/collections/{collection_id}/items/{document_id}/get Get one agent runtime event · GetAgentRuntimeEvent #
Ask an LLM
“Can I look up a single agent runtime event by its document id?”
“Which fields of an agent runtime event can I choose to return?”
Tell an agent
Get runtime event {document_id} from collection {collection_id}.
Fetch only {select_fields} of runtime event {document_id} in {collection_id}.
DELETE /agent-runtime-events/collections/{collection_id}/items/{document_id} Delete an agent runtime event · DeleteAgentRuntimeEvent #
Ask an LLM
“How do I delete a recorded agent runtime event?”
“Can a deleted agent runtime event be recovered?”
Tell an agent destructive · confirm first
Delete runtime event {document_id} from collection {collection_id}.
Remove agent runtime event {document_id} in {collection_id}.
POST /agent-runtime-events/collections/{collection_id}/list List agent runtime events in a collection · ListAgentRuntimeEvent #
Ask an LLM
“What runtime events have my agents recorded in a collection?”
“Can I query and sort agent runtime events instead of paging through all of them?”
Tell an agent
List the agent runtime events in collection {collection_id}.
Show runtime events in {collection_id} sorted by {sort}.
POST /agent-runtime-events/collections/{collection_id}/items/{document_id}/upsert Create or update an agent runtime event · UpsertAgentRuntimeEvent #
Ask an LLM
“Can I write an agent runtime event record that is created if missing?”
“How do I replace specific fields on an existing agent runtime event?”
Tell an agent
Upsert runtime event {document_id} in collection {collection_id} with {data}.
Replace fields {fields_to_replace} on runtime event {document_id} in {collection_id}.

Documentation

📖
Documentation
https://relevanceai.com/docs
📖
APIReference
https://api-f1db6c.stack.tryrelevance.com/latest/documentation
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/authentication/relevance-ai-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/openapi/relevance-ai-agent-runtime-events-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/errors/relevance-ai-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/data-model/relevance-ai-data-model.yml

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/relevance-ai:relevance-ai-agent-runtime-events-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

relevance-ai-agent-runtime-events-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Relevance AI Endpoints
  title: Relevance AI Endpoints Agent Runtime Events API
  version: latest
  contact:
    email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
  - Authorization
tags:
- name: Agent Runtime Events
paths:
  /agent-runtime-events/collections/{collection_id}/items/{document_id}/get:
    get:
      summary: GetAgentRuntimeEvent
      tags:
      - Agent Runtime Events
      description: '### Required permissions

        > []'
      operationId: GetAgentRuntimeEvent
      parameters:
      - name: collection_id
        in: path
        description: ID of collection
        required: true
        schema:
          type: string
          maxLength: 240
          pattern: ^[a-zd._-]+$
      - name: document_id
        in: path
        description: ID of document
        required: true
        schema:
          type: string
          maxLength: 240
          pattern: ^[a-zd._-]+$
      - in: query
        name: select_fields
        schema:
          type: array
          items:
            type: string
          description: Fields to include in the search results, empty array/list means all fields.
        description: Fields to include in the search results, empty array/list means all fields.
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAgentRuntimeEventOutput'
  /agent-runtime-events/collections/{collection_id}/items/{document_id}:
    delete:
      summary: DeleteAgentRuntimeEvent
      tags:
      - Agent Runtime Events
      description: '### Required permissions

        > []'
      operationId: DeleteAgentRuntimeEvent
      parameters:
      - name: collection_id
        in: path
        description: ID of collection
        required: true
        schema:
          type: string
          maxLength: 240
          pattern: ^[a-zd._-]+$
      - name: document_id
        in: path
        description: ID of document
        required: true
        schema:
          type: string
          maxLength: 240
          pattern: ^[a-zd._-]+$
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAgentRuntimeEventInput'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAgentRuntimeEventOutput'
  /agent-runtime-events/collections/{collection_id}/list:
    post:
      summary: ListAgentRuntimeEvent
      tags:
      - Agent Runtime Events
      description: '### Required permissions

        > []'
      operationId: ListAgentRuntimeEvent
      parameters:
      - name: collection_id
        in: path
        description: ID of collection
        required: true
        schema:
          type: string
          maxLength: 240
          pattern: ^[a-zd._-]+$
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAgentRuntimeEventInput'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAgentRuntimeEventOutput'
  /agent-runtime-events/collections/{collection_id}/items/{document_id}/upsert:
    post:
      summary: UpsertAgentRuntimeEvent
      tags:
      - Agent Runtime Events
      description: '### Required permissions

        > []'
      operationId: UpsertAgentRuntimeEvent
      parameters:
      - name: collection_id
        in: path
        description: ID of collection
        required: true
        schema:
          type: string
          maxLength: 240
          pattern: ^[a-zd._-]+$
      - name: document_id
        in: path
        description: ID of document
        required: true
        schema:
          type: string
          maxLength: 240
          pattern: ^[a-zd._-]+$
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertAgentRuntimeEventInput'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertAgentRuntimeEventOutput'
components:
  schemas:
    UpsertAgentRuntimeEventOutput:
      type: object
      additionalProperties: false
    DeleteAgentRuntimeEventInput: {}
    UpsertAgentRuntimeEventInput:
      type: object
      properties:
        data:
          type: object
          properties:
            input:
              type: object
              properties:
                type:
                  type: string
                  enum:
                  - use_tool
                  - record_tool_use
                  - error
                  - agent_message
                  - run_until_end
                  - run_one_step
                  - user_message
                  - finish
                use_tool:
                  type: object
                  properties:
                    params:
                      type: object
                      additionalProperties: true
                    name:
                      type: string
                    agent_fills_inputs:
                      type: boolean
                      default: true
                  required:
                  - params
                  - name
                  additionalProperties: false
                record_tool_use:
                  type: object
                  properties:
                    params:
                      type: object
                      additionalProperties: true
                    name:
                      type: string
                    output:
                      type: object
                      additionalProperties: true
                  required:
                  - params
                  - name
                  - output
                  additionalProperties: false
                error:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                  - message
                  additionalProperties: false
                agent_message:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                  - message
                  additionalProperties: false
                user_message:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                  - message
                  additionalProperties: false
              required:
              - type
              additionalProperties: false
            output:
              type: object
              properties:
                status:
                  type: string
                  enum:
                  - success
                requires_approval:
                  type: boolean
                output:
                  type: object
                  description: output of last tool ran
                params:
                  type: object
                  description: params of last tool ran
                name:
                  type: string
                  description: name of last tool ran
          additionalProperties: false
        insert_if_not_exists:
          type: boolean
          description: If true, will create the metadata if it does not exist. Defaults to true.
        fields_to_remove:
          type: array
          items:
            type: string
          description: Fields to remove from the metadata.
        fields_to_replace:
          type: array
          items:
            type: string
          description: Fields to replace in the metadata.
        fields_to_increment:
          type: object
          additionalProperties:
            type: number
      additionalProperties: false
      required:
      - data
    ListAgentRuntimeEventInput:
      type: object
      properties:
        filters:
          type: array
          items:
            type: object
            properties:
              condition:
                type: string
              case_insensitive:
                type: boolean
              field:
                type: string
              filter_type:
                type: string
                enum:
                - exact_match
                - exists
                - ilike
                - regexp
                - ids
                - date
                - numeric
                - or
                - and
                - size
                - array_object_match
              condition_value: {}
        select_fields:
          type: array
          items:
            type: string
          description: Fields to include in the search results, empty array/list means all fields.
        page_size:
          type: integer
          description: Size of each page of results
        page:
          type: integer
          description: Page of the results
        sort:
          type: array
          items:
            oneOf:
            - type: string
            - type: object
              additionalProperties:
                type: string
                enum:
                - asc
                - desc
          description: 'Fields to sort by. For each field, sort by descending or ascending. If you are using descending by datetime, it will get the most recent ones. Can be provided in format ["sortfield","subsortfield"] or in format [{"sortfield":"desc"}, {"subsortfield":"asc"}]. If provided as a query parameter, use: sort=${JSON.stringify([{"sortfield":"desc"}])}'
        include_vector:
          type: boolean
          description: Include vectors in the search results.
        after_id:
          type: array
          items: {}
          description: Retrieve items after these sort values in the sort order.
        query:
          type: string
    GetAgentRuntimeEventOutput:
      type: object
      properties:
        insert_date_: {}
        update_date: {}
        expiry_date_: {}
        project:
          type: string
        _id:
          type: string
        feature:
          type: string
        collection_id:
          type: string
        document_id:
          type: string
        data:
          type: object
          properties:
            input:
              type: object
              properties:
                type:
                  type: string
                  enum:
                  - use_tool
                  - record_tool_use
                  - error
                  - agent_message
                  - run_until_end
                  - run_one_step
                  - user_message
                  - finish
                use_tool:
                  type: object
                  properties:
                    params:
                      type: object
                      additionalProperties: true
                    name:
                      type: string
                    agent_fills_inputs:
                      type: boolean
                      default: true
                  required:
                  - params
                  - name
                  additionalProperties: false
                record_tool_use:
                  type: object
                  properties:
                    params:
                      type: object
                      additionalProperties: true
                    name:
                      type: string
                    output:
                      type: object
                      additionalProperties: true
                  required:
                  - params
                  - name
                  - output
                  additionalProperties: false
                error:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                  - message
                  additionalProperties: false
                agent_message:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                  - message
                  additionalProperties: false
                user_message:
                  type: object
                  properties:
                    message:
                      type: string
                  required:
                  - message
                  additionalProperties: false
              required:
              - type
              additionalProperties: false
            output:
              type: object
              properties:
                status:
                  type: string
                  enum:
                  - success
                requires_approval:
                  type: boolean
                output:
                  type: object
                  description: output of last tool ran
                params:
                  type: object
                  description: params of last tool ran
                name:
                  type: string
                  description: name of last tool ran
          additionalProperties: false
        deleted_date: {}
      required:
      - insert_date_
      - update_date
      - project
      - _id
      - feature
      - collection_id
      - document_id
      - data
    DeleteAgentRuntimeEventOutput: {}
    ListAgentRuntimeEventOutput:
      type: object
      properties:
        results:
          type: array
          items:
            type: object
            properties:
              insert_date_: {}
              update_date: {}
              expiry_date_: {}
              project:
                type: string
              _id:
                type: string
              feature:
                type: string
              collection_id:
                type: string
              document_id:
                type: string
              data:
                type: object
                properties:
                  input:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                        - use_tool
                        - record_tool_use
                        - error
                        - agent_message
                        - run_until_end
                        - run_one_step
                        - user_message
                        - finish
                      use_tool:
                        type: object
                        properties:
                          params:
                            type: object
                            additionalProperties: true
                          name:
                            type: string
                          agent_fills_inputs:
                            type: boolean
                            default: true
                        required:
                        - params
                        - name
                        additionalProperties: false
                      record_tool_use:
                        type: object
                        properties:
                          params:
                            type: object
                            additionalProperties: true
                          name:
                            type: string
                          output:
                            type: object
                            additionalProperties: true
                        required:
                        - params
                        - name
                        - output
                        additionalProperties: false
                      error:
                        type: object
                        properties:
                          message:
                            type: string
                        required:
                        - message
                        additionalProperties: false
                      agent_message:
                        type: object
                        properties:
                          message:
                            type: string
                        required:
                        - message
                        additionalProperties: false
                      user_message:
                        type: object
                        properties:
                          message:
                            type: string
                        required:
                        - message
                        additionalProperties: false
                    required:
                    - type
                    additionalProperties: false
                  output:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                        - success
                      requires_approval:
                        type: boolean
                      output:
                        type: object
                        description: output of last tool ran
                      params:
                        type: object
                        description: params of last tool ran
                      name:
                        type: string
                        description: name of last tool ran
                additionalProperties: false
              deleted_date: {}
            required:
            - insert_date_
            - update_date
            - project
            - _id
            - feature
            - collection_id
            - document_id
            - data
      required:
      - results
      additionalProperties: false
  securitySchemes:
    AuthorizationHeader:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorization credentials. Header authorization should be in the form of: project:api_key'
x-provenance:
  method: harvested
  publisher: Relevance AI
  source: https://api-f1db6c.stack.tryrelevance.com/latest/openapi_schema.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)