Appearance
Utilities
FreshCreate chat token
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Generate a Chat Token to be used to authenticate clients to the Chat Service.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Chat.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Request
This endpoint expects an object.
ttlintegerRequired1-43200
The maximum time, in minutes, that the access token will be valid for. Between 1 and 43,200 (30 days).
channelsobjectRequired
User-defined channel names with read/write permissions. Max of 500 channels. Channel names cannot start with the reserved prefix sw_ and can be up to 250 characters.
member_idstringOptional<=250 characters
The unique identifier of the member. Up to 250 characters. If not specified, a random UUID will be generated.
stateobjectOptionalDefaults to {}
An arbitrary JSON object available to store stateful application information in. Must be valid JSON and have a maximum size of 2,000 characters.
Response
The request has succeeded.
tokenstring
The generated Chat Token.
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
Create document
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Creates a Datasphere Document.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: DataSphere.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Request
This endpoint expects an object.
Sentence strategyobjectRequired
Show 5 properties
OR
Sliding strategyobjectRequired
Show 5 properties
OR
Page strategyobjectRequired
Show 3 properties
OR
Paragraph strategyobjectRequired
Show 3 properties
Response
The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
Unique ID of the Document.
filenamestring
Name of the Document.
statusenum
Status of the Document.
Allowed values:submittedin_progresscompletedfailed
tagslist of strings
Document tags.
chunking_strategyenum
Strategy used to chunk the document.
Allowed values:sentenceparagraphpagesliding
max_sentences_per_chunkinteger or null
Max Sentences per Chunk. Only present when chunking strategy is 'sentence', null otherwise.
split_newlinesboolean or null
Split on Newlines. Only present when chunking strategy is 'sentence', null otherwise.
overlap_sizeinteger or null
Overlap Size. Only present when chunking strategy is 'sliding', null otherwise.
chunk_sizeinteger or null
Chunk Size. Only present when chunking strategy is 'sliding', null otherwise.
number_of_chunksinteger
Number of Chunks in the Document.
chunks_uristring
URI path to the chunks for this document.
created_atdatetime
Document Creation Date.
updated_atdatetime
Document Update Date.
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Delete document
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Deletes a Datasphere Document by ID.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: DataSphere.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of a Document.
Response
There is no content to send for this request, but the headers may be useful.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Get document
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Retrieves a Datasphere Document by ID.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: DataSphere.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of a Document.
Response
The request has succeeded.
idstringformat: "uuid"
Unique ID of the Document.
filenamestring
Name of the Document.
statusenum
Status of the Document.
tagslist of strings
Document tags.
chunking_strategyenum
Strategy used to chunk the document.
max_sentences_per_chunkinteger or null
Max Sentences per Chunk. Only present when chunking strategy is 'sentence', null otherwise.
split_newlinesboolean or null
Split on Newlines. Only present when chunking strategy is 'sentence', null otherwise.
overlap_sizeinteger or null
Overlap Size. Only present when chunking strategy is 'sliding', null otherwise.
chunk_sizeinteger or null
Chunk Size. Only present when chunking strategy is 'sliding', null otherwise.
number_of_chunksinteger
Number of Chunks in the Document.
chunks_uristring
URI path to the chunks for this document.
created_atdatetime
Document Creation Date.
updated_atdatetime
Document Update Date.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List documents
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A list of Datasphere Documents.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: DataSphere.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Query parameters
page_numberintegerOptional>=0Defaults to 0
The page number to retrieve (0-indexed).
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination. Required when page_number > 0.
Response
The request has succeeded.
datalist of objects
A list of documents.
linksobject
Pagination links.
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Search documents
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Search Datasphere Documents.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: DataSphere.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Request
This endpoint expects an object.
query_stringstringRequired
Search term.
tagslist of stringsOptional
Document tags.
document_idstringOptionalformat: "uuid"
Unique ID of a Document.
distancedoubleOptional0-78.3836717690617
Specifies how closely related the query is to the document. Low distance means high relevance and similarity. High distance means low relevance and similarity.
countintegerOptional>=1Defaults to 5
Specifies number of returned Chunks.
languagestringOptionalDefaults to en
Language of the Document.
pos_to_expandlist of stringsOptionalDefaults to ["NOUN","VERB","ADJ","ADV"]
Part of Speech considered for expansion or analysis.
max_synonymsintegerOptional>=1Defaults to 10
Maximum number of synonyms to consider.
Response
The request has succeeded.
chunkslist of objects
A list of search result chunks.
Errors
400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Update document
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Updates a Datasphere Document by ID.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: DataSphere.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of a Document.
Request
This endpoint expects an object.
tagslist of stringsRequired
Document tags.
Response
The request has succeeded.
idstringformat: "uuid"
Unique ID of the Document.
filenamestring
Name of the Document.
statusenum
Status of the Document.
Allowed values:submittedin_progresscompletedfailed
tagslist of strings
Document tags.
chunking_strategyenum
Strategy used to chunk the document.
Allowed values:sentenceparagraphpagesliding
max_sentences_per_chunkinteger or null
Max Sentences per Chunk. Only present when chunking strategy is 'sentence', null otherwise.
split_newlinesboolean or null
Split on Newlines. Only present when chunking strategy is 'sentence', null otherwise.
overlap_sizeinteger or null
Overlap Size. Only present when chunking strategy is 'sliding', null otherwise.
chunk_sizeinteger or null
Chunk Size. Only present when chunking strategy is 'sliding', null otherwise.
number_of_chunksinteger
Number of Chunks in the Document.
chunks_uristring
URI path to the chunks for this document.
created_atdatetime
Document Creation Date.
updated_atdatetime
Document Update Date.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Request MFA token via call
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sends a multi-factor authentication code via voice call.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Management.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Request
This endpoint expects an object.
tostringRequired
The E164 number to use as the destination.
fromstringOptional
The E164 number from your account to use as the origin of the message. SignalWire will use a special verified number if not specified.
messagestringOptionalDefaults to Your Personal Authorization Code is:
Specify a custom message to send before the token. The message must fit within one segment; either 160 characters or 70 characters when using non-GSM symbols.
token_lengthintegerOptionalDefaults to 6
The number of characters in the token, from 4 to 20. Defaults to 6.
valid_forintegerOptionalDefaults to 3600
The number of seconds the token is considered valid for. Defaults to 3600, with a maximum of 604800.
max_attemptsintegerOptionalDefaults to 3
The number of allowed verification attempts, including the first one, from 1 to 20. Defaults to 3.
allow_alphasbooleanOptionalDefaults to false
Set to true or false, whether to include letters or just numbers in the token. Defaults to false (numbers only).
Response
The request has succeeded.
idstringformat: "uuid"
The MFA request ID. Save this for verification.
successboolean
Whether the request was successfully queued.
tostring
The destination of the MFA request.
channelstring
Can be sms for a text message or call for a phone call.
Errors
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Request MFA token via SMS
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sends a multi-factor authentication code via SMS.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Management.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Request
This endpoint expects an object.
tostringRequired
The E164 number to use as the destination.
fromstringOptional
The E164 number from your account to use as the origin of the message. SignalWire will use a special verified number if not specified.
messagestringOptionalDefaults to Your Personal Authorization Code is:
Specify a custom message to send before the token. The message must fit within one segment; either 160 characters or 70 characters when using non-GSM symbols.
token_lengthintegerOptionalDefaults to 6
The number of characters in the token, from 4 to 20. Defaults to 6.
valid_forintegerOptionalDefaults to 3600
The number of seconds the token is considered valid for. Defaults to 3600, with a maximum of 604800.
max_attemptsintegerOptionalDefaults to 3
The number of allowed verification attempts, including the first one, from 1 to 20. Defaults to 3.
allow_alphasbooleanOptionalDefaults to false
Set to true or false, whether to include letters or just numbers in the token. Defaults to false (numbers only).
Response
The request has succeeded.
idstringformat: "uuid"
The MFA request ID. Save this for verification.
successboolean
Whether the request was successfully queued.
tostring
The destination of the MFA request.
channelstring
Can be sms for a text message or call for a phone call.
Errors
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
Verify MFA token
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Verifies a multi-factor authentication code.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Management.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
mfa_request_idstringRequiredformat: "uuid"
The MFA request ID.
Request
This endpoint expects an object.
tokenstringRequired
The token to verify.
Response
The request has succeeded.
successboolean
Whether the token was successfully verified by the API. When max_attempts are reached or the request is no longer valid, the endpoint will return a 404 Not Found.
Errors
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error
List queue members
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Returns a list of members in a queue.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
queue_idstringRequiredformat: "uuid"
Unique ID of the queue.
Response
The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of queue members.
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Get next queue member
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Retrieves the next member in the queue without dequeuing.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
queue_idstringRequiredformat: "uuid"
Unique ID of the queue.
Response
The request has succeeded.
call_idstringformat: "uuid"
The call ID of the queue member.
project_idstring
The ID of the project associated with this queue member.
queue_idstring
The ID of the queue associated with this queue member.
positioninteger
Queue member position in the queue.
uristring
The URL of this queue member.
wait_timeinteger
Wait time in seconds since the member was enqueued. If not yet enqueued, it will be null.
date_enqueueddatetime
When the queue member was last enqueued.
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Get queue member
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Retrieves the details of a queue member.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
queue_idstringRequiredformat: "uuid"
Unique ID of the queue.
idstringRequiredformat: "uuid"
The unique identifier (ID) of the queue member.
Response
The request has succeeded.
call_idstringformat: "uuid"
The call ID of the queue member.
project_idstring
The ID of the project associated with this queue member.
queue_idstring
The ID of the queue associated with this queue member.
positioninteger
Queue member position in the queue.
uristring
The URL of this queue member.
wait_timeinteger
Wait time in seconds since the member was enqueued. If not yet enqueued, it will be null.
date_enqueueddatetime
When the queue member was last enqueued.
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List short codes
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Returns a list of your short codes. The short codes are returned sorted by creation date, with the most recent appearing first.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Query parameters
filter_namestringOptional
Filter by name. Returns all short codes containing this value as a substring.
filter_numberstringOptional
Filter by number. Returns all short codes containing this value as a substring.
page_numberintegerOptionalDefaults to 0
The page number to retrieve.
page_sizeintegerOptional1-1000Defaults to 50
The number of results per page.
page_tokenstringOptional
Token for cursor-based pagination.
Response
The request has succeeded.
linksobject
Pagination links.
Show 4 properties
datalist of objects
List of short codes.
Show 18 properties
Errors
400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
Get short code
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Retrieves the details of a short code.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the short code.
Response
The request has succeeded.
idstringformat: "uuid"
The unique identifier of the short code.
namestring or null
The name given to the short code.
numberstring
The short code number.
capabilitieslist of enums
The messaging capabilities of the short code.
number_typeenum
The type of number (always ‘shortcode’).
code_typeenum
The type of short code.
country_codestring
The ISO 3166-1 alpha-2 country code.
created_atstring
The date and time when the short code was created.
updated_atstring
The date and time when the short code was last updated.
next_billed_atstring or null
The date and time when the short code will next be billed.
lease_durationstring or null
The lease duration of the short code (e.g., ‘12 months’).
message_handlerenum or null
The message handler type for incoming messages.
message_request_urlstring or null
The URL to send message requests to when using laml_webhooks handler.
message_request_methodenum or null
The HTTP method to use for message requests.
message_fallback_urlstring or null
The fallback URL for message requests.
message_fallback_methodenum or null
The HTTP method to use for fallback requests.
message_laml_application_idstring or nullformat: "uuid"
The ID of the LāML application to handle messages when using laml_application handler.
message_relay_contextstring or null
The Relay context to use when using relay_context handler.
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Update short code
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Updates a short code’s configuration.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the short code.
Request
This endpoint expects an object.
namestringRequired<=255 characters
The name given to the short code.
message_handlerenumRequired
The message handler type for incoming messages.
Allowed values:relay_contextlaml_webhookslaml_application
message_request_urlstringOptional
The URL to send message requests to when using laml_webhooks handler.
message_request_methodenumOptionalDefaults to POST
The HTTP method to use for message requests. Defaults to POST.
Allowed values:GETPOST
message_fallback_urlstringOptional
The fallback URL for message requests.
message_fallback_methodenumOptionalDefaults to POST
The HTTP method to use for fallback requests. Defaults to POST.
Allowed values:GETPOST
message_laml_application_idstringOptionalformat: "uuid"
The ID of the LāML application to handle messages when using laml_application handler.
message_relay_contextstringOptional
The Relay context to use when using relay_context handler.
Response
The request has succeeded.
idstringformat: "uuid"
The unique identifier of the short code.
namestring or null
The name given to the short code.
numberstring
The short code number.
capabilitieslist of enums
The messaging capabilities of the short code.
Allowed values:smsmms
number_typeenum
The type of number (always ‘shortcode’).
Allowed values:shortcode
code_typeenum
The type of short code.
Allowed values:vanityrandom
country_codestring
The ISO 3166-1 alpha-2 country code.
created_atstring
The date and time when the short code was created.
updated_atstring
The date and time when the short code was last updated.
next_billed_atstring or null
The date and time when the short code will next be billed.
lease_durationstring or null
The lease duration of the short code (e.g., ‘12 months’).
message_handlerenum or null
The message handler type for incoming messages.
Allowed values:relay_contextlaml_webhookslaml_application
message_request_urlstring or null
The URL to send message requests to when using laml_webhooks handler.
message_request_methodenum or null
The HTTP method to use for message requests.
Allowed values:GETPOST
message_fallback_urlstring or null
The fallback URL for message requests.
message_fallback_methodenum or null
The HTTP method to use for fallback requests.
Allowed values:GETPOST
message_laml_application_idstring or nullformat: "uuid"
The ID of the LāML application to handle messages when using laml_application handler.
message_relay_contextstring or null
The Relay context to use when using relay_context handler.
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Get video log
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Find a log by ID.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Path parameters
idstringRequiredformat: "uuid"
Unique ID of the log.
Response
Response model for video log retrieve endpoint.
Video.Logobject
Log object representing a video activity entry.
Show 12 properties
OR
Deleted Logobject
A discarded/deleted video log entry. Returned when the log has been deleted. Only present when include_deleted is true.
Show 3 properties
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
List video logs
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
List the available logs.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.
Learn more about API scopes.
Authentication
AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token.
The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.
Example:
Authorization: Basic base64(project_id:token)Query parameters
include_deletedbooleanOptionalDefaults to false
Include logs for deleted activity.
created_beforestringOptional
Return logs for activity prior to this date. Accepts date (YYYY-MM-DD) or ISO 8601 datetime formats.
created_onstringOptional
Return logs for activity on this date. Accepts date (YYYY-MM-DD) or ISO 8601 datetime formats.
created_afterstringOptional
Return logs for activity after this date. Accepts date (YYYY-MM-DD) or ISO 8601 datetime formats.
page_numberintegerOptional>=0Defaults to 0
Page number to return.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_tokenstringOptional
Token for cursor-based pagination.
Response
The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of logs.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error