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/getsocialclaw-com:getsocialclaw-com-status-and-authentication-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

openapi: 3.2.0
info:
  title: SocialClaw Status and Authentication API
  version: 1.0.0
  description: Complete SocialClaw API reference for social account connections, media uploads, validation, scheduling, publishing, analytics, dashboard APIs, webhooks, and delivery URLs.
servers:
- url: https://getsocialclaw.com
  description: SocialClaw production API
security:
- BearerAuth: []
tags:
- name: Status and Authentication
  description: Health checks, API key validation, and workspace key management.
paths:
  /health:
    get:
      tags:
      - Status and Authentication
      operationId: get_health
      summary: Service health
      description: 'Returns service, database, storage, worker, billing, and public URL health.


        Note: Use this route for uptime checks. It does not require a workspace or API key.


        Note: The response includes deployment configuration, not tenant-specific account health.'
      security: []
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, or unauthorized credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request body or semantic validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-socialclaw-auth: none
      x-socialclaw-surface: public
  /v1/keys/validate:
    post:
      tags:
      - Status and Authentication
      operationId: post_v1_keys_validate
      summary: Validate API key
      description: Checks the bearer token, returns the workspace, and updates last-used metadata.
      security:
      - BearerAuth: []
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyValidationResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, or unauthorized credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request body or semantic validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-socialclaw-auth: bearer
      x-socialclaw-surface: public
  /v1/keys:
    get:
      tags:
      - Status and Authentication
      operationId: get_v1_keys
      summary: List API keys
      description: Lists API key metadata for the authenticated workspace. Secrets are not returned from the public key API.
      security:
      - BearerAuth: []
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeysResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, or unauthorized credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request body or semantic validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-socialclaw-auth: bearer
      x-socialclaw-surface: public
    post:
      tags:
      - Status and Authentication
      operationId: post_v1_keys
      summary: Create API key
      description: Creates an additional API key for the authenticated workspace.
      security:
      - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyCreateRequest'
      responses:
        '201':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyCreateResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, or unauthorized credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request body or semantic validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-socialclaw-auth: bearer
      x-socialclaw-surface: public
  /v1/keys/{keyId}:
    delete:
      tags:
      - Status and Authentication
      operationId: delete_v1_keys_keyId
      summary: Revoke API key
      description: Revokes an API key. The current key cannot revoke itself through this public route.
      security:
      - BearerAuth: []
      parameters:
      - name: keyId
        in: path
        required: true
        schema:
          type: string
        description: API key id to revoke.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyCreateResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, or unauthorized credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request body or semantic validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-socialclaw-auth: bearer
      x-socialclaw-surface: public
  /v1/me/usage:
    get:
      tags:
      - Status and Authentication
      operationId: get_v1_me_usage
      summary: Workspace usage
      description: Returns workspace usage counters and entitlement consumption.
      security:
      - BearerAuth: []
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, or unauthorized credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request body or semantic validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-socialclaw-auth: bearer
      x-socialclaw-surface: public
  /v1/workspace/health:
    get:
      tags:
      - Status and Authentication
      operationId: get_v1_workspace_health
      summary: Workspace health
      description: Returns tenant-specific account, scheduling, and workspace health.
      security:
      - BearerAuth: []
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceHealthResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, or unauthorized credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request body or semantic validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-socialclaw-auth: bearer
      x-socialclaw-surface: public
  /v1/jobs:
    get:
      tags:
      - Status and Authentication
      operationId: get_v1_jobs
      summary: List jobs
      description: Lists worker jobs for the workspace.
      security:
      - BearerAuth: []
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter by job status.
      - name: provider
        in: query
        required: false
        schema:
          type: string
        description: Filter by provider.
      - name: account
        in: query
        required: false
        schema:
          type: string
        description: Filter by account handle.
      - name: runId
        in: query
        required: false
        schema:
          type: string
        description: Filter by run id. Also accepted as run_id.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 500
        description: Maximum jobs to return.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobsResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, or unauthorized credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request body or semantic validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-socialclaw-auth: bearer
      x-socialclaw-surface: public
components:
  schemas:
    HealthResponse:
      type: object
      description: Service health response.
      additionalProperties: true
      properties:
        ok:
          const: true
        service:
          type: string
          description: Service name.
        now:
          type: string
          description: Server time.
          format: date-time
        db:
          type: object
          additionalProperties: true
        assetStorage:
          type: object
          additionalProperties: true
        maxAssetBytes:
          type: integer
          description: Maximum base64 upload size.
        publicBaseUrl:
          type: string
          description: Configured public base URL.
          format: uri
      required:
      - ok
      - service
      - now
    ApiKey:
      type: object
      description: API key metadata. Secret values are only returned when a key is created or shown in the dashboard key API.
      additionalProperties: false
      properties:
        id:
          type: string
          description: API key id, for example key_abc123.
        prefix:
          type:
          - string
          - 'null'
          description: Public prefix used to identify the key without exposing the secret.
        label:
          type:
          - string
          - 'null'
          description: Optional human label.
        kind:
          type:
          - string
          - 'null'
          description: Key kind, such as personal or agent.
        secret:
          type:
          - string
          - 'null'
          description: Raw key secret. Only present at creation or in dashboard key listings.
        createdAt:
          type:
          - string
          - 'null'
          description: Creation time.
          format: date-time
        revokedAt:
          type:
          - string
          - 'null'
          description: Revocation time.
          format: date-time
        lastUsedAt:
          type:
          - string
          - 'null'
          description: Last successful API authentication time.
          format: date-time
      required:
      - id
    JobsResponse:
      type: object
      description: Job list response.
      additionalProperties: true
      properties:
        ok:
          const: true
        jobs:
          type: array
          description: Jobs.
          items:
            type: object
            additionalProperties: true
        total:
          type: integer
          description: Total matching jobs.
      required:
      - ok
    UsageResponse:
      type: object
      description: Workspace usage response.
      additionalProperties: true
      properties:
        ok:
          const: true
        usage:
          type: object
          additionalProperties: true
      required:
      - ok
      - usage
    Tenant:
      type: object
      description: Workspace visible to the authenticated API key or dashboard session.
      additionalProperties: true
      properties:
        id:
          type: string
          description: Workspace id.
        name:
          type:
          - string
          - 'null'
          description: Workspace name.
        plan:
          type:
          - string
          - 'null'
          description: Workspace plan.
        subscriptionStatus:
          type:
          - string
          - 'null'
          description: Billing subscription status.
        entitlements:
          type:
          - object
          - 'null'
          description: Plan capabilities and limits.
      required:
      - id
    KeyCreateResponse:
      type: object
      description: API key creation response.
      additionalProperties: true
      properties:
        ok:
          const: true
        key:
          $ref: '#/components/schemas/ApiKey'
        apiKey:
          $ref: '#/components/schemas/ApiKey'
        secret:
          type:
          - string
          - 'null'
          description: Raw secret when returned as a top-level value.
      required:
      - ok
    WorkspaceHealthResponse:
      type: object
      description: Workspace health response.
      additionalProperties: true
      properties:
        ok:
          const: true
        health:
          type: object
          additionalProperties: true
      required:
      - ok
      - health
    KeysResponse:
      type: object
      description: API key list response.
      additionalProperties: false
      properties:
        ok:
          const: true
        keys:
          type: array
          description: Keys in the workspace.
          items:
            $ref: '#/components/schemas/ApiKey'
      required:
      - ok
      - keys
    KeyCreateRequest:
      type: object
      description: Creates an API key.
      additionalProperties: true
      properties:
        label:
          type:
          - string
          - 'null'
          description: Optional label.
        kind:
          type:
          - string
          - 'null'
          description: Dashboard-only key kind.
    ErrorResponse:
      type: object
      description: Standard error response returned by JSON API routes.
      additionalProperties: false
      properties:
        ok:
          const: false
          description: Always false for errors.
        code:
          type:
          - string
          - 'null'
          description: Stable machine-readable error code.
        message:
          type: string
          description: Human-readable error message.
        details:
          type:
          - object
          - array
          - string
          - number
          - boolean
          - 'null'
          description: Optional route-specific details.
      required:
      - ok
      - message
    KeyValidationResponse:
      type: object
      description: Valid API key response.
      additionalProperties: true
      properties:
        ok:
          const: true
        tenant:
          $ref: '#/components/schemas/Tenant'
        apiKey:
          $ref: '#/components/schemas/ApiKey'
      required:
      - ok
      - tenant
      - apiKey
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: SocialClaw API key
    DashboardSession:
      type: apiKey
      in: cookie
      name: socialclaw_dash_session
    WebhookSignature:
      type: apiKey
      in: header
      name: x-signature
externalDocs:
  description: Human-readable SocialClaw API documentation.
  url: https://getsocialclaw.com/docs/api
x-provenance:
  method: harvested
  publisher: SocialClaw
  source: https://getsocialclaw.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)