Emboss

Emboss Sessions API

The Sessions API from Emboss — 5 operation(s) for sessions.

GitHub OpenAPI

Operations 5

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

POST /sessions Start an interactive fill session for a form · Create Session #
Ask an LLM
“How do I start filling a form field by field interactively?”
“Can I open an editing session on one of my forms?”
Tell an agent
Start a fill session for form {form_id}.
Open an interactive editing session on {form_id}.
GET /sessions/{sid} Get a fill session's current field values · Get Session #
Ask an LLM
“What values have been entered so far in my fill session?”
“Can I resume a session and see its current state?”
Tell an agent
Show fill session {sid}.
Get the current field values in session {sid}.
PUT /sessions/{sid}/fields Set field values in a fill session · Put Fields #
Ask an LLM
“How do I enter or change answers in an open fill session?”
“Can I update several fields in a session at once?”
Tell an agent
Update session {sid} fields with {updates}.
Set these answers {updates} in fill session {sid}.
POST /sessions/{sid}/fill Render the filled PDF for a session · Fill #
Ask an LLM
“How do I finish a session and produce the filled PDF?”
“Once my session answers are in, how is the document generated?”
Tell an agent
Fill the form for session {sid}.
Generate the filled document from session {sid}'s answers.
GET /sessions/{sid}/pdf Download a session's filled PDF · Session Pdf #
Ask an LLM
“Where do I download the PDF from a completed fill session?”
“Can I fetch the latest filled file for a session?”
Tell an agent
Download the PDF for session {sid}.
Save session {sid}'s filled form.

Documentation

📖
Documentation
https://getemboss.ai/docs
📖
APIReference
https://getemboss.ai/docs/reference/create-form
📖
GettingStarted
https://getemboss.ai/docs/quickstart
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/authentication/getemboss-ai-authentication.yml
📖
Authentication
https://getemboss.ai/docs/authentication
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/rate-limits/getemboss-ai-rate-limits.yml
📖
Documentation
https://getemboss.ai/docs/pay-per-call
📖
Documentation
https://getemboss.ai/docs/pay-per-call/mpp
📖
Documentation
https://getemboss.ai/docs/pay-per-call/x402

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/openapi/getemboss-ai-sessions-api-openapi.yml

Other Resources

🔗
Console
https://api.getemboss.ai/docs
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/scopes/getemboss-ai-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/conventions/getemboss-ai-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/conventions/getemboss-ai-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/errors/getemboss-ai-problem-types.yml
🔗
ErrorCatalog
https://getemboss.ai/docs/reference/errors
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/data-model/getemboss-ai-data-model.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/sandbox/getemboss-ai-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/asyncapi/getemboss-ai-callbacks.yml
🔗
Webhooks
https://getemboss.ai/docs/callbacks
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/llms/getemboss-ai-pay-llms.txt
🔗
LLMsTxt
https://api.getemboss.ai/pay/llms.txt
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/getemboss-ai/refs/heads/main/plans/getemboss-ai-plans-pricing.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/getemboss-ai:getemboss-ai-sessions-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

getemboss-ai-sessions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fast Sessions API
  version: 0.1.0
security:
- bearer: []
- oauth2:
  - forms:read
  - forms:write
tags:
- name: Sessions
paths:
  /sessions:
    post:
      summary: Create Session
      operationId: create_session_sessions_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Sessions
  /sessions/{sid}:
    get:
      summary: Get Session
      operationId: get_session_sessions__sid__get
      parameters:
      - name: sid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Sid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Sessions
  /sessions/{sid}/fields:
    put:
      summary: Put Fields
      operationId: put_fields_sessions__sid__fields_put
      parameters:
      - name: sid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Sid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Sessions
  /sessions/{sid}/fill:
    post:
      summary: Fill
      operationId: fill_sessions__sid__fill_post
      parameters:
      - name: sid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Sid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Sessions
  /sessions/{sid}/pdf:
    get:
      summary: Session Pdf
      operationId: session_pdf_sessions__sid__pdf_get
      parameters:
      - name: sid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Sid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Sessions
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    FieldUpdate:
      properties:
        field_id:
          type: integer
          title: Field Id
        value:
          anyOf:
          - type: string
          - type: 'null'
          title: Value
      type: object
      required:
      - field_id
      - value
      title: FieldUpdate
    FieldsRequest:
      properties:
        updates:
          items:
            $ref: '#/components/schemas/FieldUpdate'
          type: array
          title: Updates
      type: object
      required:
      - updates
      title: FieldsRequest
    SessionCreate:
      properties:
        form_id:
          type: string
          title: Form Id
      type: object
      required:
      - form_id
      title: SessionCreate
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: Emboss API key (sk_...)
      description: An Emboss API key. See https://getemboss.ai/docs/authentication.
    oauth2:
      type: oauth2
      description: Sign in with your Emboss account. See https://getemboss.ai/docs/authentication.
      flows:
        authorizationCode:
          authorizationUrl: https://api.getemboss.ai/oauth/authorize
          tokenUrl: https://api.getemboss.ai/oauth/token
          scopes:
            forms:read: Read your forms
            forms:write: Create and fill forms