How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SignalWire Documents API

Manage Datasphere documents.

SignalWire Documents API is one of 80 APIs that SignalWire publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 6 operations across 3 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{space_name}.signalwire.com.

6 operations 3 paths 25 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{space_name}.signalwire.com
Authentication
HTTP Basic, HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 2

SignalWire Documents API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (SignalWireBasicAuth). It accepts HTTP bearer tokens (SignalWireBearerAuth). By default, every request must be authenticated.

  • SignalWireBasicAuth — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed…
  • SignalWireBearerAuth — SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer follow…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 6

Manage Datasphere documents.

GET
/api/datasphere/documents
List documents
list_documents 3 params → 200400401422500
POST
/api/datasphere/documents
Create document
create_document body → 201400401422500
POST
/api/datasphere/documents/search
Search documents
search_documents body → 200400401422500
GET
/api/datasphere/documents/{id}
Get document
get_document 1 param → 200400401404500
PATCH
/api/datasphere/documents/{id}
Update document
update_document 1 param body → 200400401404422500
DELETE
/api/datasphere/documents/{id}
Delete document
delete_document 1 param → 204400401404500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Datasphere.Document (13 properties), Datasphere.DocumentSearchRequest (8 properties), Types.StatusCodes.RestApiErrorItem (5 properties), Datasphere.PaginationResponse (4 properties). Each schema is shown below with its type and property counts.

Types.StatusCodes.StatusCode401
object
Access is unauthorized.
1 property 1 required
Datasphere.DocumentCreatePageRequest
object
1 property
Datasphere.UpdateStatusCode422
object
The request contains invalid parameters. See errors for details.
1 property 1 required
Datasphere.CreateStatusCode422
object
The request contains invalid parameters. See errors for details.
1 property 1 required
Datasphere.Document
object
13 properties 13 required
Types.StatusCodes.StatusCode400
object
The request is invalid.
1 property 1 required
Datasphere.Chunk
object
2 properties 2 required
uuid
string
Universal Unique Identifier.
Types.StatusCodes.StatusCode404
object
The server cannot find the requested resource.
1 property 1 required
Datasphere.SearchResponse
object
1 property 1 required
Types.StatusCodes.StatusCode500
object
An internal server error occurred.
1 property 1 required
Datasphere.DocumentCreateRequest
Datasphere.DocumentUpdateRequest
object
1 property 1 required
Datasphere.DocumentCreateSlidingRequest
object
3 properties
Datasphere.ChunkingStrategy
string
Strategy to use when chunking the document.
Datasphere.SearchStatusCode422
object
The request contains invalid parameters. See errors for details.
1 property 1 required
Datasphere.PaginationResponse
object
4 properties 2 required
Types.StatusCodes.RestApiErrorItem
object
Details about a specific error.
5 properties 4 required
Datasphere.DocumentListResponse
object
2 properties 2 required
Datasphere.ListStatusCode422
object
The request contains invalid parameters. See errors for details.
1 property 1 required
Datasphere.DocumentCreateParagraphRequest
object
1 property
Datasphere.DocumentCreateSentenceRequest
object
3 properties
Datasphere.DocumentStatus
string
The current Status of the Document.
Datasphere.DocumentSearchRequest
object
8 properties 1 required
Datasphere.DocumentCreateRequestBase
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signalwire-documents-api-openapi.yml Raw ↑

Other APIs SignalWire publishes across the network.

SignalWire Calling API (JSON-RPC)
SignalWire Accounts API
SignalWire Addresses API
SignalWire AI Agents: Custom API
SignalWire AI Agents: Dialogflow API
SignalWire AI Chat API
SignalWire AI Webhooks API
SignalWire Applications API
SignalWire Available Phone Numbers API
SignalWire Call Flows API
SignalWire Calling Webhooks API
SignalWire Calls API
Where this information came from

This is an independent, third-party profile of SignalWire Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.