Subchapter 1.5
references/projects.mdMarkdown16 KBView on GitHub
All API requests require authentication. Two methods are supported:
Use Authorization: Token <API_KEY>
Example: Authorization: Token 12345abcdef
Use Authorization: Bearer <JWT>
Example: Authorization: Bearer eyJhbGciOiJ...
List Projects
Retrieves basic information about the projects associated with the API key
200: A list of projects 400: Invalid Request
Get a Project
Retrieves information about the specified project
limit number (default: 10) — Number of results to return per page. Default 10. Range [1,1000]page number — Navigate and return the results to retrieve specific portions of information of the response200: A project 400: Invalid Request
Update a Project
Updates the name or other properties of an existing project
application/json
name string — The name of the project200: A project 400: Invalid Request
Delete a Project
Deletes the specified project
200: A project 400: Invalid Request
Leave a Project
Removes the authenticated account from the specific project
200: Successfully removed account from project 400: Invalid Request
List Project Keys
Retrieves all API keys associated with the specified project
status active | expired — Only return keys with a specific status200: A list of API keys 400: Invalid Request
Create a Project Key
Creates a new API key with specified settings for the project
application/json
200: API key created successfully 400: Invalid Request
Get a Project Key
Retrieves information about a specified API key
200: A specific API key 400: Invalid Request
Delete a Project Key
Deletes an API key for a specific project
200: API key deleted 400: Invalid Request
List Project Members
Retrieves a list of members for a given project
200: A list of members for a given project 400: Invalid Request
Delete a Project Member
Removes a member from the project using their unique member ID
200: Delete the specific member from the project 400: Invalid Request
List Project Member Scopes
Retrieves a list of scopes for a specific member
200: A list of scopes for a specific member 400: Invalid Request
Update Project Member Scopes
Updates the scopes for a specific member
application/json
scope string (required) — A scope to update200: Updated the scopes for a specific member 400: Invalid Request
List Project Invites
Generates a list of invites for a specific project
200: A list of invites for a specific project 400: Invalid Request
Create a Project Invite
Generates an invite for a specific project
application/json
email string (required) — The email address of the inviteescope string (required) — The scope of the invitee200: The invite was successfully generated 400: Invalid Request
Delete a Project Invite
Deletes an invite for a specific project
200: The invite was successfully deleted 400: Invalid Request
List Project Requests
Generates a list of requests for a specific project
start string — Start date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MMend string — End date of the requested date range. Formats accepted are YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+HH:MMlimit number (default: 10) — Number of results to return per page. Default 10. Range [1,1000]page number — Navigate and return the results to retrieve specific portions of information of the responseaccessor string — Filter for requests where a specific accessor was usedrequest_id string — Filter for a specific request iddeployment hosted | beta | self-hosted — Filter for requests where a specific deployment was usedendpoint listen | read | speak | agent — Filter for requests where a specific endpoint was usedmethod sync | async | streaming — Filter for requests where a specific method was usedstatus succeeded | failed — Filter for requests that succeeded (status code < 300) or failed (status code >=400)200: A list of requests for a specific project 400: Invalid Request
Get a Project Request
Retrieves a specific request for a specific project
200: A specific request for a specific project 400: Invalid Request
Get Project Usage
Retrieves the usage for a specific project. Use Get Project Usage Breakdown for a more comprehensive usage summary.
start string — Start date of the requested date range. Format accepted is YYYY-MM-DDend string — End date of the requested date range. Format accepted is YYYY-MM-DDaccessor string — Filter for requests where a specific accessor was usedalternatives boolean — Filter for requests where alternatives were usedcallback_method boolean — Filter for requests where callback method was usedcallback boolean — Filter for requests where callback was usedchannels boolean — Filter for requests where channels were usedcustom_intent_mode boolean — Filter for requests where custom intent mode was usedcustom_intent boolean — Filter for requests where custom intent was usedcustom_topic_mode boolean — Filter for requests where custom topic mode was usedcustom_topic boolean — Filter for requests where custom topic was useddeployment hosted | beta | self-hosted — Filter for requests where a specific deployment was useddetect_entities boolean — Filter for requests where detect entities was useddetect_language boolean — Filter for requests where detect language was useddiarize boolean — Filter for requests where diarize was useddictation boolean — Filter for requests where dictation was usedencoding boolean — Filter for requests where encoding was usedendpoint listen | read | speak | agent — Filter for requests where a specific endpoint was usedextra boolean — Filter for requests where extra was usedfiller_words boolean — Filter for requests where filler words was usedintents boolean — Filter for requests where intents was usedkeyterm boolean — Filter for requests where keyterm was usedkeywords boolean — Filter for requests where keywords was usedlanguage boolean — Filter for requests where language was usedmeasurements boolean — Filter for requests where measurements were usedmethod sync | async | streaming — Filter for requests where a specific method was usedmodel string — Filter for requests where a specific model uuid was usedmultichannel boolean — Filter for requests where multichannel was usednumerals boolean — Filter for requests where numerals were usedparagraphs boolean — Filter for requests where paragraphs were usedprofanity_filter boolean — Filter for requests where profanity filter was usedpunctuate boolean — Filter for requests where punctuate was usedredact boolean — Filter for requests where redact was usedreplace boolean — Filter for requests where replace was usedsample_rate boolean — Filter for requests where sample rate was usedsearch boolean — Filter for requests where search was usedsentiment boolean — Filter for requests where sentiment was usedsmart_format boolean — Filter for requests where smart format was usedsummarize boolean — Filter for requests where summarize was usedtag string — Filter for requests where a specific tag was usedtopics boolean — Filter for requests where topics was usedutt_split boolean — Filter for requests where utt split was usedutterances boolean — Filter for requests where utterances was usedversion boolean — Filter for requests where version was used200: A specific request for a specific project 400: Invalid Request
List Project Usage Fields
Lists the features, models, tags, languages, and processing method used for requests in the specified project
start string — Start date of the requested date range. Format accepted is YYYY-MM-DDend string — End date of the requested date range. Format accepted is YYYY-MM-DD200: A list of fields for a specific project 400: Invalid Request
Get Project Usage Breakdown
Retrieves the usage breakdown for a specific project, with various filter options by API feature or by groupings. Setting a feature (e.g. diarize) to true includes requests that used that feature, while false excludes requests that used it. Multiple true filters are combined with OR logic, while false filters use AND logic.
start string — Start date of the requested date range. Format accepted is YYYY-MM-DDend string — End date of the requested date range. Format accepted is YYYY-MM-DDgrouping accessor | endpoint | feature_set | models | method | tags | deployment — Common usage grouping parametersaccessor string — Filter for requests where a specific accessor was usedalternatives boolean — Filter for requests where alternatives were usedcallback_method boolean — Filter for requests where callback method was usedcallback boolean — Filter for requests where callback was usedchannels boolean — Filter for requests where channels were usedcustom_intent_mode boolean — Filter for requests where custom intent mode was usedcustom_intent boolean — Filter for requests where custom intent was usedcustom_topic_mode boolean — Filter for requests where custom topic mode was usedcustom_topic boolean — Filter for requests where custom topic was useddeployment hosted | beta | self-hosted — Filter for requests where a specific deployment was useddetect_entities boolean — Filter for requests where detect entities was useddetect_language boolean — Filter for requests where detect language was useddiarize boolean — Filter for requests where diarize was useddictation boolean — Filter for requests where dictation was usedencoding boolean — Filter for requests where encoding was usedendpoint listen | read | speak | agent — Filter for requests where a specific endpoint was usedextra boolean — Filter for requests where extra was usedfiller_words boolean — Filter for requests where filler words was usedintents boolean — Filter for requests where intents was usedkeyterm boolean — Filter for requests where keyterm was usedkeywords boolean — Filter for requests where keywords was usedlanguage boolean — Filter for requests where language was usedmeasurements boolean — Filter for requests where measurements were usedmethod sync | async | streaming — Filter for requests where a specific method was usedmodel string — Filter for requests where a specific model uuid was usedmultichannel boolean — Filter for requests where multichannel was usednumerals boolean — Filter for requests where numerals were usedparagraphs boolean — Filter for requests where paragraphs were usedprofanity_filter boolean — Filter for requests where profanity filter was usedpunctuate boolean — Filter for requests where punctuate was usedredact boolean — Filter for requests where redact was usedreplace boolean — Filter for requests where replace was usedsample_rate boolean — Filter for requests where sample rate was usedsearch boolean — Filter for requests where search was usedsentiment boolean — Filter for requests where sentiment was usedsmart_format boolean — Filter for requests where smart format was usedsummarize boolean — Filter for requests where summarize was usedtag string — Filter for requests where a specific tag was usedtopics boolean — Filter for requests where topics was usedutt_split boolean — Filter for requests where utt split was usedutterances boolean — Filter for requests where utterances was usedversion boolean — Filter for requests where version was used200: Usage breakdown response 400: Invalid Request
Get Project Balances
Generates a list of outstanding balances for the specified project
200: A list of outstanding balances 400: Invalid Request
Get a Project Balance
Retrieves details about the specified balance
200: A specific balance 400: Invalid Request
Get Project Billing Breakdown
Retrieves the billing summary for a specific project, with various filter options or by grouping options.
start string — Start date of the requested date range. Format accepted is YYYY-MM-DDend string — End date of the requested date range. Format accepted is YYYY-MM-DDaccessor string — Filter for requests where a specific accessor was useddeployment hosted | beta | self-hosted — Filter for requests where a specific deployment was usedtag string — Filter for requests where a specific tag was usedline_item string — Filter requests by line item (e.g. streaming::nova-3)grouping accessor | deployment | line_item | tags[] — Group billing breakdown by one or more dimensions (accessor, deployment, line_item, tags)200: Billing breakdown response 400: Invalid Request
List Project Billing Fields
Lists the accessors, deployment types, tags, and line items used for billing data in the specified time period. Use this endpoint if you want to filter your results from the Billing Breakdown endpoint and want to know what filters are available.
start string — Start date of the requested date range. Format accepted is YYYY-MM-DDend string — End date of the requested date range. Format accepted is YYYY-MM-DD200: A list of billing fields for a specific project 400: Invalid Request
List Project Purchases
Returns the original purchased amount on an order transaction
limit number (default: 10) — Number of results to return per page. Default 10. Range [1,1000]200: A list of purchases for a specific project 400: Invalid Request
This file
Nearby