FaceSign

FaceSign Sessions API

The Sessions API from FaceSign — 3 operation(s) for sessions.

GitHub OpenAPI

Operations 4

GET /sessions GET /sessions #
POST /sessions POST /sessions #
GET /sessions/string GET /sessions/string #
GET /sessions/string/refresh GET /sessions/string/refresh #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/facesign-ai/openapi/facesign-ai-sessions-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/facesign-ai/json-schema/facesign-ai-post-sessions-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/facesign-ai/json-schema/facesign-ai-get-sessions-string-refresh-response-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/facesign-ai:facesign-ai-sessions-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

facesign-ai-sessions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Facesign Ai Sessions API
  version: '2026-11-07'
  x-authored-by: API Evangelist
  x-engine: anthropic
  x-evidence-tiers:
    code-example: 6
    documentation: 0
    pages-with-code: 11
    pages-read: 15
  x-generated: '2026-11-07'
  x-generated-from: documentation
  x-generator: generate-contract-from-docs.py
  x-provenance: generated
  x-sources:
  - https://docs.facesign.ai/docs/reference/sdks
  - https://docs.facesign.ai/docs/reference/avatars
  - https://docs.facesign.ai/docs/reference/concepts
  - https://docs.facesign.ai/docs/reference/languages
  - https://docs.facesign.ai/docs/reference/authentication
  - https://docs.facesign.ai/docs/reference/webhook-events
  - https://docs.facesign.ai/docs/api-reference/getLangs
  - https://docs.facesign.ai/docs/api-reference/getAvatars
  - https://docs.facesign.ai/docs/api-reference/getSession
  - https://docs.facesign.ai/docs/api-reference/listSessions
  - https://docs.facesign.ai/docs/api-reference/createSession
  - https://docs.facesign.ai/docs/api-reference/createClientSecret
  - https://docs.facesign.ai/docs/guides/add-webhooks
  - https://docs.facesign.ai/docs/guides/customize-branding
  - https://docs.facesign.ai/docs/guides/custom-pages
  description: 'Operations tagged Sessions across 2 of this provider''s published API definitions: facesign-ai-openapi-generated.yml, facesign-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.facesign.ai
security:
- bearer: []
tags:
- name: Sessions
paths:
  /sessions:
    get:
      operationId: get_sessions
      tags:
      - Sessions
      summary: GET /sessions
      x-source: https://docs.facesign.ai/docs/reference/authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://api.facesign.ai/sessions  -H \"Authorization: Bearer sk_test_...\" import Client from '@facesignai/api' \n const client = new Client ({ \n auth: process.env. FACESIGN_API_KEY , \n }) import os \n import facesignai \n client = facesignai.Client( \n auth = os.environ.get( \"FACESIGN_API_KEY\" ) \n ) \n The key prefix is the only thing that changes between environments — swap sk_test_... for sk_prod"
    post:
      operationId: post_sessions
      tags:
      - Sessions
      summary: POST /sessions
      x-source: https://docs.facesign.ai/docs/reference/sdks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSessionsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl / REST API \n You can also use the FaceSign API directly via HTTP requests: \n Direct API usage curl -X POST https://api.facesign.ai/sessions  -H \"Authorization: Bearer YOUR_API_KEY\"  -H \"Content-Type: application/json\"  -d '{ \n \"clientReferenceId\": \"user-123\", \n \"flow\": [ \n {\"id\": \"start\", \"type\": \"start\", \"outcome\": \"end\"}, \n {\"id\": \"end\", \"type\": \"end\"} \n ] \n }' \n Next steps \n Sessions Learn"
    servers:
    - url: https://api.facesign.ai
  /sessions/string:
    get:
      operationId: get_sessions_string
      tags:
      - Sessions
      summary: GET /sessions/string
      x-source: https://docs.facesign.ai/docs/api-reference/getSession
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl JavaScript Go Python Java C# curl -X GET \"https://api.facesign.ai/sessions/string\" 200 401 404 429 { \n \"session\" : { \n \"id\" : \"string\" , \n \"createdAt\" : 0 , \n \"startedAt\" : 0 , \n \"finishedAt\" : 0 , \n \"status\" : \"created\" , \n \"settings\" : { \n \"clientReferenceId\" : \"user-123\" , \n \"metadata\" : { \n \"source\" : \"web-app\" , \n \"department\" : \"sales\" \n }, \n \"initialPhrase\" : \"string\" , \n \"finalPhrase\""
    servers:
    - url: https://api.facesign.ai
  /sessions/string/refresh:
    get:
      operationId: get_sessions_string_refresh
      tags:
      - Sessions
      summary: GET /sessions/string/refresh
      x-source: https://docs.facesign.ai/docs/api-reference/createClientSecret
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSessionsStringRefreshResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl JavaScript Go Python Java C# curl -X GET \"https://api.facesign.ai/sessions/string/refresh\" 200 400 401 404 409 429 { \n \"secret\" : \"string\" , \n \"createdAt\" : 0 , \n \"expireAt\" : 0 , \n \"url\" : \"string\" \n } { \n \"error\" : \"string\" , \n \"code\" : \"session_finished\" \n } { \n \"error\" : { \n \"type\" : \"authentication_error\" , \n \"message\" : \"Invalid API key provided\" \n } \n } { \n \"error\" : { \n \"type\" : \"not_"
    servers:
    - url: https://api.facesign.ai
components:
  schemas:
    PostSessionsRequest:
      type: object
      properties:
        clientReferenceId:
          type: string
        flow:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              type:
                type: string
              outcome:
                type: string
    GetSessionsStringRefreshResponse:
      type: object
      properties:
        secret:
          type: string
        createdAt:
          type: integer
        expireAt:
          type: integer
        url:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
x-refined-from:
- facesign-ai-openapi-generated.yml
- facesign-ai-openapi.yml