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/vertesiahq:vertesiahq-api-keys-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:
  title: Vertesia API Keys API
  version: 1.6.0-dev.20261019.172735Z
  x-api-version: '20260803'
  description: The Vertesia API provides project-scoped access to interaction execution and content workflows. Use it to run interactions, inspect execution history, stream run progress, replay previous executions, and search content objects and collections. Authenticate requests with a bearer token, or use the official `@vertesia/client` package for typed access from Node.js applications.
  contact:
    name: Vertesia
    url: https://vertesiahq.com/
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  x-scalar-sdk-installation:
  - lang: Node
    description: 'Install the **Vertesia Client** from npm:'
    source: npm install @vertesia/client
servers:
- url: https://api.{region}.vertesia.io/api/v1
  description: Vertesia API
  variables:
    region:
      default: us1
      enum:
      - us1
      - eu1
      - jp1
      description: Regional API host label. `us1` is the global endpoint.
tags:
- name: API Keys
  description: API Key endpoints manage project and account API credentials used to authenticate automation and external clients.
paths:
  /apikeys:
    parameters:
    - name: x-api-version
      in: header
      required: true
      schema:
        type: string
        minLength: 1
        pattern: \S
        example: '20260803'
      description: Required Vertesia API version header. Use `20260803` for the current stable API shape.
      x-vertesia-global-header: true
    post:
      operationId: CreateApiKey
      tags:
      - API Keys
      summary: Create an API key
      description: 'Creates a new API key and returns the raw key value once at creation time.


        **Required permissions:** `api_key:create`'
      security:
      - bearerAuth: []
      parameters: []
      responses:
        '200':
          description: The created API key and raw secret value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyWithValue'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - api_key:create
      x-vertesia-source:
        file: ../../apps/studio-server/src/api/apikeys.ts
        className: ApiKeysResource
        methodName: createApiKey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApiKeyPayload'
    get:
      operationId: ListApiKeys
      tags:
      - API Keys
      summary: List API keys
      description: 'Lists API keys for the current project or, for account administrators, across accessible projects in the account.


        **Required permissions:** `api_key:read`'
      security:
      - bearerAuth: []
      - OAuth2:
        - api_key:read
      parameters:
      - name: level
        in: query
        required: false
        schema:
          type: string
          enum:
          - account
          - project
      responses:
        '200':
          description: API keys.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyArray'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - api_key:read
      x-vertesia-source:
        file: ../../apps/studio-server/src/api/apikeys.ts
        className: ApiKeysResource
        methodName: getApiKeys
  /apikeys/{keyId}:
    parameters:
    - name: x-api-version
      in: header
      required: true
      schema:
        type: string
        minLength: 1
        pattern: \S
        example: '20260803'
      description: Required Vertesia API version header. Use `20260803` for the current stable API shape.
      x-vertesia-global-header: true
    delete:
      operationId: DeleteApiKey
      tags:
      - API Keys
      summary: Delete an API key
      description: 'Deletes an API key by ID.


        **Required permissions:** `api_key:delete`'
      security:
      - bearerAuth: []
      parameters:
      - name: keyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: API key deletion result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteOperationResult'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - api_key:delete
      x-vertesia-source:
        file: ../../apps/studio-server/src/api/apikeys.ts
        className: ApiKeysResource
        methodName: deleteApiKey
    put:
      operationId: UpdateApiKey
      tags:
      - API Keys
      summary: Update an API key
      description: 'Updates API key metadata, security attributes, and enabled state.


        **Required permissions:** `api_key:update`'
      security:
      - bearerAuth: []
      parameters:
      - name: keyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The updated API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKey'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - api_key:update
      x-vertesia-source:
        file: ../../apps/studio-server/src/api/apikeys.ts
        className: ApiKeysResource
        methodName: updateApiKey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateApiKeyPayload'
    get:
      operationId: GetApiKey
      tags:
      - API Keys
      summary: Retrieve an API key
      description: 'Retrieves API key metadata. The raw key value is returned only once, on creation.


        **Required permissions:** `api_key:read`'
      security:
      - bearerAuth: []
      - OAuth2:
        - api_key:read
      parameters:
      - name: keyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKey'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - api_key:read
      x-vertesia-source:
        file: ../../apps/studio-server/src/api/apikeys.ts
        className: ApiKeysResource
        methodName: getApiKey
  /apikeys/{keyId}/token:
    parameters:
    - name: x-api-version
      in: header
      required: true
      schema:
        type: string
        minLength: 1
        pattern: \S
        example: '20260803'
      description: Required Vertesia API version header. Use `20260803` for the current stable API shape.
      x-vertesia-global-header: true
    get:
      operationId: GetApiKeyToken
      tags:
      - API Keys
      summary: Get an API key token
      description: 'Returns a generated auth token derived from a retrievable API key value.


        **Required permissions:** `api_key:secret_read`'
      security:
      - bearerAuth: []
      parameters:
      - name: keyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Generated API key token response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthTokenResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Server Error
                status: 500
                message: Internal server error.
        4XX:
          description: Client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
                status: 400
                message: Request validation failed.
      x-vertesia-permissions:
      - api_key:secret_read
      x-vertesia-source:
        file: ../../apps/studio-server/src/api/apikeys.ts
        className: ApiKeysResource
        methodName: getApiKeyToken
components:
  schemas:
    ApiKeyWithValue:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          $ref: '#/components/schemas/ApiKeyTypes'
        role:
          $ref: '#/components/schemas/SystemRoles'
        maskedValue:
          type: string
        can_retrieve_value:
          type: boolean
        account:
          type: string
        project:
          $ref: '#/components/schemas/ProjectRef'
        enabled:
          type: boolean
        scim_provisioning:
          type: boolean
          description: Organization-wide SCIM provisioning credential. Only account administrators may create or manage these keys. May be enabled by account administrators on existing keys; disable or delete to revoke access.
        created_by:
          type: string
        updated_by:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
        properties:
          type: object
          additionalProperties: true
          description: Custom properties for dynamic permission matching (PrincipalSet / $principal. conditions)
        clearance:
          type: number
          description: BLP clearance level — the maximum document sensitivity the key can access
        compartments:
          type: array
          items:
            type: string
          description: Compartments the key belongs to — restricts access to matching documents
        value:
          type: string
      required:
      - id
      - name
      - type
      - role
      - account
      - project
      - enabled
      - created_by
      - updated_by
      - created_at
      - updated_at
      - value
      additionalProperties: false
    UpdateApiKeyPayload:
      type: object
      properties:
        name:
          type: string
        role:
          $ref: '#/components/schemas/SystemRoles'
        enabled:
          type: boolean
        scim_provisioning:
          type: boolean
          description: Organization-wide SCIM provisioning credential. Only account administrators may create or manage these keys. May be enabled by account administrators on existing keys; disable or delete to revoke access.
        properties:
          type: object
          additionalProperties: true
          description: Custom properties for dynamic permission matching (PrincipalSet / $principal. conditions)
        clearance:
          type: number
          description: BLP clearance level — the maximum document sensitivity the key can access
        compartments:
          type: array
          items:
            type: string
          description: Compartments the key belongs to — restricts access to matching documents
      additionalProperties: false
    ApiKeyArray:
      type: array
      items:
        $ref: '#/components/schemas/ApiKey'
    ApiKeyTypes:
      type: string
      const: sk
    CreateApiKeyPayload:
      type: object
      properties:
        name:
          type: string
        role:
          $ref: '#/components/schemas/SystemRoles'
        type:
          $ref: '#/components/schemas/ApiKeyTypes'
        expires_at:
          type: string
          format: date-time
        scim_provisioning:
          type: boolean
          description: Organization-wide SCIM provisioning credential. Only account administrators may create or manage these keys. May be enabled by account administrators on existing keys; disable or delete to revoke access.
        properties:
          type: object
          additionalProperties: true
          description: Custom properties for dynamic permission matching (PrincipalSet / $principal. conditions)
        clearance:
          type: number
          description: BLP clearance level — the maximum document sensitivity the key can access
        compartments:
          type: array
          items:
            type: string
          description: Compartments the key belongs to — restricts access to matching documents
      required:
      - name
      - role
      additionalProperties: false
    SystemRoles:
      type: string
      enum:
      - owner
      - admin
      - app_admin
      - manager
      - developer
      - application
      - automation
      - content_processor
      - consumer
      - executor
      - reader
      - auditor
      - support
      - billing
      - member
      - app_member
      - content_superadmin
    ProjectRef:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        account:
          type: string
        restricted:
          type: boolean
          description: Only set when fetching the list of projects visible to an user which is an org admin or owner. If present and true, it means that the project is not accessible to the user.(even if it visible in listing) If not present or false then the project is accessible to the user.
      required:
      - id
      - name
      - account
      additionalProperties: false
    AuthTokenResponse:
      type: object
      properties:
        token:
          type: string
      required:
      - token
      additionalProperties: false
    DeleteOperationResult:
      type: object
      properties:
        acknowledged:
          type: boolean
        deletedCount:
          type: number
      required:
      - acknowledged
      - deletedCount
      additionalProperties: false
    ErrorResponse:
      type: object
      description: Standard JSON error response returned by the server error handler.
      properties:
        error:
          type: string
          description: HTTP status text or normalized error type.
        status:
          type: integer
          format: int32
          minimum: 400
          maximum: 599
          description: HTTP status code. Client errors use a 4xx status code; server errors use 500.
          example: 400
        message:
          type: string
          description: Human-readable error message.
        details:
          type: string
          description: Optional additional error details.
        errorCode:
          type: string
          description: Machine-readable code for the specific failure, present when the error carries one, so clients can branch on it without parsing `message`.
          example: account_api_key_creation_disabled
      required:
      - error
      - status
      additionalProperties: false
    ApiKey:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        type:
          $ref: '#/components/schemas/ApiKeyTypes'
        role:
          $ref: '#/components/schemas/SystemRoles'
        maskedValue:
          type: string
        can_retrieve_value:
          type: boolean
        account:
          type: string
        project:
          $ref: '#/components/schemas/ProjectRef'
        enabled:
          type: boolean
        scim_provisioning:
          type: boolean
          description: Organization-wide SCIM provisioning credential. Only account administrators may create or manage these keys. May be enabled by account administrators on existing keys; disable or delete to revoke access.
        created_by:
          type: string
        updated_by:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
        properties:
          type: object
          additionalProperties: true
          description: Custom properties for dynamic permission matching (PrincipalSet / $principal. conditions)
        clearance:
          type: number
          description: BLP clearance level — the maximum document sensitivity the key can access
        compartments:
          type: array
          items:
            type: string
          description: Compartments the key belongs to — restricts access to matching documents
      required:
      - id
      - name
      - type
      - role
      - account
      - project
      - enabled
      - created_by
      - updated_by
      - created_at
      - updated_at
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://cloud.us1.vertesia.io/oauth/authorize
          tokenUrl: https://sts.vertesia.io/oauth/token
          x-scalar-security-query:
            resource: https://api.us1.vertesia.io/api/v1
          x-scalar-security-body:
            resource: https://api.us1.vertesia.io/api/v1
          scopes:
            openid: ''
            profile: ''
            offline_access: ''
            interaction:read: ''
            interaction:write: ''
            interaction:delete: ''
            interaction:execute: ''
            run:read: ''
            run:write: ''
            environment:admin: ''
            app:manage: ''
            project:admin: ''
            project:integration_read: ''
            project:settings_write: ''
            api_key:read: ''
            account:read: ''
            account:write: ''
            account:admin: ''
            audit:read: ''
            account:member: ''
            content:read: ''
            content:read_all: ''
            content:write: ''
            content:delete: ''
            content:admin: ''
            content:superadmin: ''
            workflow:read: ''
            workflow:run: ''
            workflow:admin: ''
            workflow:superadmin: ''
            agent_run:read: ''
            task:read: ''
            task:manage: ''
x-tagGroups:
- name: Authentication
  tags:
  - Token Service
- name: GenAI
  tags:
  - Environments
  - Prompt Templates
  - Interactions
  - Interaction Runs
  - Agent Runs
- name: Content
  tags:
  - Content Object Types
  - Objects
  - Collections
  - Files
  - Rendering
  - Bulk Operations
  - Commands
- name: Data Store
  tags:
  - Data
- name: Workflow
  tags:
  - Processes
  - Tasks
  - Workflow Definitions
  - Workflow Rules
  - Workflow Runs
- name: Administration
  tags:
  - Accounts
  - Projects
  - Audit Trail
  - Costs
- name: Access Control
  tags:
  - Users
  - User Groups
  - Roles
  - Access Control Entries
  - API Keys
- name: Apps & Integrations
  tags:
  - Apps
  - OAuth Providers
  - OAuth Clients
  - OAuth Grants
  - Remote MCP Connections