Orq.ai

Orq.ai Views API

The Views API from Orq.ai — 2 operation(s) for views.

GitHub OpenAPI

Operations 5

GET /v3/views List visible saved views #
POST /v3/views Create a saved view #
GET /v3/views/{view_id} Retrieve a saved view #
DELETE /v3/views/{view_id} Delete a saved view #
PATCH /v3/views/{view_id} Update a saved view #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/orq/openapi/orq-views-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/orq/json-schema/orq-invoke-deployment-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/orq/json-schema/orq-search-knowledge-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/orq/json-schema/orq-response-stream-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/orq/json-schema/orq-agent-thought-streaming-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/orq/json-schema/orq-agent-started-streaming-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/orq/json-schema/orq-model-metadata-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/orq:orq-views-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

orq-views-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: orq.ai Views API
  version: '2.0'
  description: orq.ai API documentation
servers:
- url: https://my.orq.ai
security:
- ApiKey: []
tags:
- name: Views
paths:
  /v3/views:
    get:
      tags:
      - Views
      summary: List visible saved views
      operationId: ViewList
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          format: uint32
      - name: starting_after
        in: query
        schema:
          type: string
      - name: ending_before
        in: query
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListViewsResponse'
        '401':
          description: Authentication required. See https://docs.orq.ai/reference/errors for the error codes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-speakeasy-group: views
      x-speakeasy-name-override: list
      x-code-samples:
      - lang: typescript
        label: Node.js
        source: 'import { Orq } from ''@orq-ai/node'';


          const orq = new Orq({ apiKey: process.env.ORQ_API_KEY });

          const result = await orq.views.list({ page: ''traces-studio'', limit: 100 });

          '
    post:
      tags:
      - Views
      summary: Create a saved view
      operationId: ViewCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateViewRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateViewResponse'
        '401':
          description: Authentication required. See https://docs.orq.ai/reference/errors for the error codes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-speakeasy-group: views
      x-speakeasy-name-override: create
      x-code-samples:
      - lang: typescript
        label: Node.js
        source: 'import { Orq } from ''@orq-ai/node'';


          const orq = new Orq({ apiKey: process.env.ORQ_API_KEY });

          const result = await orq.views.create({ displayName: ''Errors'', page: ''traces-studio'', filterBy: '''', columns: [] });

          '
  /v3/views/{view_id}:
    get:
      tags:
      - Views
      summary: Retrieve a saved view
      operationId: ViewGet
      parameters:
      - name: view_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetViewResponse'
        '401':
          description: Authentication required. See https://docs.orq.ai/reference/errors for the error codes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-speakeasy-group: views
      x-speakeasy-name-override: get
      x-code-samples:
      - lang: typescript
        label: Node.js
        source: 'import { Orq } from ''@orq-ai/node'';


          const orq = new Orq({ apiKey: process.env.ORQ_API_KEY });

          const result = await orq.views.get({ viewId: ''01HZXW2K7Y8Q9M0N1P2R3S4T5V'' });

          '
    delete:
      tags:
      - Views
      summary: Delete a saved view
      operationId: ViewDelete
      parameters:
      - name: view_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteViewResponse'
        '401':
          description: Authentication required. See https://docs.orq.ai/reference/errors for the error codes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-speakeasy-group: views
      x-speakeasy-name-override: delete
      x-code-samples:
      - lang: typescript
        label: Node.js
        source: 'import { Orq } from ''@orq-ai/node'';


          const orq = new Orq({ apiKey: process.env.ORQ_API_KEY });

          const result = await orq.views.delete({ viewId: ''01HZXW2K7Y8Q9M0N1P2R3S4T5V'' });

          '
    patch:
      tags:
      - Views
      summary: Update a saved view
      operationId: ViewUpdate
      parameters:
      - name: view_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateViewRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateViewResponse'
        '401':
          description: Authentication required. See https://docs.orq.ai/reference/errors for the error codes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-speakeasy-group: views
      x-speakeasy-name-override: update
      x-code-samples:
      - lang: typescript
        label: Node.js
        source: 'import { Orq } from ''@orq-ai/node'';


          const orq = new Orq({ apiKey: process.env.ORQ_API_KEY });

          const result = await orq.views.update({ viewId: ''01HZXW2K7Y8Q9M0N1P2R3S4T5V'', displayName: ''Production errors'' });

          '
components:
  schemas:
    CreateViewResponse:
      type: object
      properties:
        view:
          $ref: '#/components/schemas/View'
    GetViewResponse:
      type: object
      properties:
        view:
          $ref: '#/components/schemas/View'
    ListViewsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/View'
        has_more:
          type: boolean
    View:
      type: object
      properties:
        id:
          type: string
        display_name:
          type: string
        description:
          type: string
        workspace_id:
          type: string
        page:
          type: string
        filter_by:
          type: string
        columns:
          type: array
          items:
            type: string
        column_labels:
          type: object
          additionalProperties:
            type: string
        is_default:
          type: boolean
        private_for_ids:
          type: array
          items:
            type: string
        version:
          type: integer
          format: uint32
        created_by_id:
          type: string
        updated_by_id:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.
        code:
          type: integer
          description: gRPC status code, when the service reports one.
        details:
          type: array
          items: {}
          description: Additional error details, when the service reports any.
      required:
      - message
    CreateViewRequest:
      type: object
      properties:
        display_name:
          type: string
        description:
          type: string
        page:
          type: string
        filter_by:
          type: string
        columns:
          type: array
          items:
            type: string
        column_labels:
          type: object
          additionalProperties:
            type: string
        is_default:
          type: boolean
        is_private:
          type: boolean
        version:
          type: integer
          format: uint32
    UpdateViewResponse:
      type: object
      properties:
        view:
          $ref: '#/components/schemas/View'
    DeleteViewResponse:
      type: object
      properties: {}
    UpdateViewRequest:
      type: object
      properties:
        display_name:
          type: string
        description:
          type: string
        filter_by:
          type: string
        columns:
          type: array
          items:
            type: string
        column_labels:
          type: object
          additionalProperties:
            type: string
        is_default:
          type: boolean
        is_private:
          type: boolean
        version:
          type: integer
          format: uint32
        update_mask:
          type: string
          format: field-mask
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  url: https://docs.orq.ai
  description: orq.ai Documentation
x-speakeasy-timeout: 600000