Vertesia

Vertesia OAuth Grants API

OAuth Grant endpoints list granted OAuth access, inspect grant details, and revoke one or more OAuth grants.

GitHub OpenAPI

Operations 4

GET /oauth-grants List OAuth grants #
GET /oauth-grants/{grant_id} Retrieve an OAuth grant #
DELETE /oauth-grants/{grant_id} Revoke an OAuth grant #
POST /oauth-grants/revoke Bulk revoke OAuth grants #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/openapi/vertesiahq-oauth-grants-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-agent-run-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-update-app-payload-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-app-manifest-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-app-manifest-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-indexing-status-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-dashboard-schema.json

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/vertesiahq:vertesiahq-oauth-grants-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

vertesiahq-oauth-grants-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Vertesia OAuth Grants 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: OAuth Grants
  description: OAuth Grant endpoints list granted OAuth access, inspect grant details, and revoke one or more OAuth grants.
paths:
  /oauth-grants:
    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: ListOAuthGrants
      tags:
      - OAuth Grants
      summary: List OAuth grants
      description: 'Lists active, revoked, or expired OAuth grants visible to the current user, project admin, or account admin.


        **Required permissions:** Any of `account:member`, `project:admin`, `account:admin`'
      security:
      - bearerAuth: []
      - OAuth2:
        - account:member
      - OAuth2:
        - project:admin
      - OAuth2:
        - account:admin
      parameters:
      - name: account_id
        in: query
        required: false
        schema:
          type: string
      - name: project_id
        in: query
        required: false
        schema:
          type: string
      - name: user_id
        in: query
        required: false
        schema:
          type: string
      - name: client_id
        in: query
        required: false
        schema:
          type: string
      - name: resource
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
          enum:
          - active
          - revoked
          - expired
          - all
      - name: limit
        in: query
        required: false
        schema:
          type: number
      - name: offset
        in: query
        required: false
        schema:
          type: number
      - name: sort_by
        in: query
        required: false
        schema:
          type: string
          enum:
          - granted_at
          - client_name
          - user_name
          - resource
          - last_used_at
          - expires_at
          - status
        style: form
      - name: sort_order
        in: query
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
        style: form
      responses:
        '200':
          description: Matching OAuth grants with pagination metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthGrantListResponse'
        '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:
      - account:member
      - project:admin
      - account:admin
      x-vertesia-source:
        file: ../../apps/studio-server/src/api/oauth-grants.ts
        className: OAuthGrantsResource
        methodName: list
  /oauth-grants/{grant_id}:
    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: GetOAuthGrant
      tags:
      - OAuth Grants
      summary: Retrieve an OAuth grant
      description: 'Retrieves a single OAuth grant by its encoded grant identifier.


        **Required permissions:** Any of `account:member`, `project:admin`, `account:admin`'
      security:
      - bearerAuth: []
      - OAuth2:
        - account:member
      - OAuth2:
        - project:admin
      - OAuth2:
        - account:admin
      parameters:
      - name: grant_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested OAuth grant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthGrant'
        '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:
      - account:member
      - project:admin
      - account:admin
      x-vertesia-source:
        file: ../../apps/studio-server/src/api/oauth-grants.ts
        className: OAuthGrantsResource
        methodName: retrieve
    delete:
      operationId: RevokeOAuthGrant
      tags:
      - OAuth Grants
      summary: Revoke an OAuth grant
      description: 'Revokes the refresh tokens associated with a single OAuth grant, and optionally deletes the stored consent.


        **Required permissions:** Any of `account:member`, `project:admin`, `account:admin`'
      security:
      - bearerAuth: []
      - OAuth2:
        - account:member
      - OAuth2:
        - project:admin
      - OAuth2:
        - account:admin
      parameters:
      - name: grant_id
        in: path
        required: true
        schema:
          type: string
      - name: include_consent
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OAuth grant revocation result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthGrantRevokeResponse'
        '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:
      - account:member
      - project:admin
      - account:admin
      x-vertesia-source:
        file: ../../apps/studio-server/src/api/oauth-grants.ts
        className: OAuthGrantsResource
        methodName: revoke
  /oauth-grants/revoke:
    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: BulkRevokeOAuthGrants
      tags:
      - OAuth Grants
      summary: Bulk revoke OAuth grants
      description: 'Revokes multiple OAuth grants selected by explicit grant IDs or by account, project, user, client, resource, and status filters.


        **Required permissions:** Any of `account:member`, `project:admin`, `account:admin`'
      security:
      - bearerAuth: []
      - OAuth2:
        - account:member
      - OAuth2:
        - project:admin
      - OAuth2:
        - account:admin
      parameters: []
      responses:
        '200':
          description: Bulk OAuth grant revocation result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthGrantRevokeResponse'
        '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:
      - account:member
      - project:admin
      - account:admin
      x-vertesia-source:
        file: ../../apps/studio-server/src/api/oauth-grants.ts
        className: OAuthGrantsResource
        methodName: revokeBulk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRevokeOAuthGrantsPayload'
components:
  schemas:
    OAuthGrantSortField:
      type: string
      enum:
      - granted_at
      - client_name
      - user_name
      - resource
      - last_used_at
      - expires_at
      - status
    OAuthGrantSortOrder:
      type: string
      enum:
      - asc
      - desc
    OAuthGrantRevokeResponse:
      type: object
      properties:
        revoked_tokens:
          type: number
        revoked_consents:
          type: number
      required:
      - revoked_tokens
      - revoked_consents
      additionalProperties: false
    OAuthGrant:
      type: object
      properties:
        grant_id:
          type: string
        client_id:
          type: string
        client_name:
          type: string
        user_id:
          type: string
        user_name:
          type: string
        user_email:
          type: string
        account_id:
          type: string
        project_id:
          type: string
        resource:
          type: string
        scope:
          type: array
          items:
            type: string
        status:
          $ref: '#/components/schemas/OAuthGrantStatus'
        token_count:
          type: number
        granted_at:
          type: string
        created_at:
          type: string
        last_used_at:
          type: string
        expires_at:
          type: string
      required:
      - grant_id
      - client_id
      - client_name
      - user_id
      - account_id
      - project_id
      - resource
      - scope
      - status
      - token_count
      - granted_at
      - created_at
      additionalProperties: false
    OAuthGrantStatus:
      type: string
      enum:
      - active
      - revoked
      - expired
    OAuthGrantListResponse:
      type: object
      properties:
        grants:
          type: array
          items:
            $ref: '#/components/schemas/OAuthGrant'
        total_count:
          type: number
        limit:
          type: number
        offset:
          type: number
      required:
      - grants
      - total_count
      - limit
      - offset
      additionalProperties: false
    BulkRevokeOAuthGrantsPayload:
      type: object
      properties:
        account_id:
          type: string
        project_id:
          type: string
        user_id:
          type: string
        client_id:
          type: string
        resource:
          type: string
        status:
          type: string
          enum:
          - active
          - revoked
          - expired
          - all
        limit:
          type: number
        offset:
          type: number
        sort_by:
          $ref: '#/components/schemas/OAuthGrantSortField'
        sort_order:
          $ref: '#/components/schemas/OAuthGrantSortOrder'
        grant_ids:
          type: array
          items:
            type: string
        include_consent:
          type: boolean
      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
  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