Robin AI Templates API

Reusable prompt sets that drive Table extraction

OpenAPI Specification

robin-ai-templates-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Robin Legal Intelligence Platform Documents Templates API
  version: 0.2.0-dev
  description: 'Robin AI''s public REST API for legal contract intelligence. Exposes the

    Tables extraction engine, Documents store, reusable extraction Templates,

    typed Properties, and organizational Groups. Authenticate every request

    with an `X-API-Key` header. Lists support cursor pagination (`limit`,

    `starting_after`) and ISO 8601 date-range filters. Tables Results include

    clickable Citations linking every extracted answer back to the source

    span in the contract.

    '
  contact:
    name: Robin AI
    url: https://robinai.com/robin-api
  license:
    name: Proprietary
    url: https://robinai.com/terms
servers:
- url: https://api.robinai.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Templates
  description: Reusable prompt sets that drive Table extraction
paths:
  /v1/templates:
    get:
      operationId: listTemplates
      summary: List Templates
      tags:
      - Templates
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/CreatedBefore'
      - $ref: '#/components/parameters/CreatedAfter'
      - $ref: '#/components/parameters/UpdatedBefore'
      - $ref: '#/components/parameters/UpdatedAfter'
      - name: name
        in: query
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTemplatesResponse'
components:
  schemas:
    ListTemplatesResponse:
      type: object
      properties:
        has_more:
          type: boolean
        templates:
          type: array
          items:
            $ref: '#/components/schemas/Template'
    Template:
      type: object
      properties:
        id:
          type: string
          example: tpl_11abcd1234efgh6789
        name:
          type: string
        description:
          type: string
        prompts:
          type: array
          items:
            $ref: '#/components/schemas/Prompt'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    AnswerFormat:
      type: string
      enum:
      - text_summary
      - text_word
      - number_general
      - number_currency
      - number_percentage
      - date
      - boolean
      - list
    Prompt:
      type: object
      properties:
        name:
          type: string
        prompt_text:
          type: string
        answer_format:
          $ref: '#/components/schemas/AnswerFormat'
  parameters:
    UpdatedBefore:
      name: updated_before
      in: query
      schema:
        type: string
        format: date-time
    CreatedBefore:
      name: created_before
      in: query
      schema:
        type: string
        format: date-time
    UpdatedAfter:
      name: updated_after
      in: query
      schema:
        type: string
        format: date-time
    StartingAfter:
      name: starting_after
      in: query
      schema:
        type: string
      description: Cursor for pagination; pass the ID of the last item from the previous page.
    CreatedAfter:
      name: created_after
      in: query
      schema:
        type: string
        format: date-time
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 100
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key