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

Voxco Codebooks API

The Codebooks API from Voxco — 5 operation(s) for codebooks.

Voxco Codebooks API is one of 11 APIs that Voxco publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.0.4, at version v2.

Requests are made against 3 base URLs: https://api.goascribe.us/coder/v2, https://api.goascribe.eu/coder/v2, https://api-ca.goascribe.com/coder/v2.

7 operations 5 paths 19 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
v2
Base URL
https://na1.voxco.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Voxco Codebooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). By default, every request must be authenticated.

  • Bearer — Please enter a valid bearer token. It should be in the format "bearer eyJhbGciOiJSU..." It will be added to the "Authentication" HTTP header

Paths & Operations 7

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

Codebooks 7
GET
/Codebooks/{codebookKey}
Get a Codebook by its key
2 params → 200
GET
/Codebooks/Question/{questionKey}
Get the Codebook for a Question
2 params → 200
POST
/Codebooks/{questionKey}
Create a new Codebook for a Question
1 param body → 200
POST
/Codebooks/{codebookKey}/Codes
Add codes to a codebook
1 param body → 200
PUT
/Codebooks/{codebookKey}/Codes
Updates codes in a specified codebook
1 param body → 200
DELETE
/Codebooks/{codebookKey}/Codes
Deletes codes from the specified codebook.
1 param body → 200
POST
/Codebooks/Codes/Batch
Add codes into target codebooks
body → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are CodeOrNet (7 properties), UpdateCode (6 properties), NewCodeOrNet (6 properties), ResponseCodeRemoved (5 properties). Each schema is shown below with its type and property counts.

CreateCodebookForQuestionRequest
object
A codebook presentation to create for specified question
1 property 1 required
AddCodesIntoCodebookRequest
object
A codebook presentation to create for specified question
2 properties
CodebookNewCodes
object
Codebook and its codes or nets tree structure
2 properties
ResponseCodeRemoved
object
Contains information about codes that were uncode from responses
5 properties 5 required
AddCodesIntoCodebookResponse
object
Contains a presentation of codebook
3 properties
DeleteCodebookCodesRequest
object
Request contains an array of code keys to delete from codebook
2 properties
FailedCode
object
Contains information about failed code.
2 properties
UpdateCodesInCodebookRequest
object
Request contains information
2 properties 1 required
AddCodesIntoCodebooksBatchResponse
object
Response contains information about added codes into a linked codebook or error message
2 properties
CodeOrNet
object
A Code or Net in a Codebook.
7 properties 2 required
AddCodesIntoCodebooksBatchRequest
object
Request contains a list of codebooks and their codes to add
2 properties
DeleteCodebookCodesResponse
object
Response contains two arrays with successfully-deleted and failed codes after the try of deletion. Codebook code can not be deleted if it is applied for some r…
4 properties
UpdateCode
object
Class contains information about code and its properties to update. Only not-null properties will be updated, i.e. for properties with null value the code save…
6 properties
GetQuestionCodebookResponse
object
Contains a presentation of codebook
3 properties
AddCodesIntoCodebooksBatchResultItem
object
Result item with information about status of adding codes into the specified codebook
3 properties
UpdateCodesInCodebookResponse
object
Response contains information about failed codes. If a code with some key from the request is not presented in failedCodes collection it means that the code wa…
4 properties
NewCodeOrNet
object
A Code or Net in a Codebook.
6 properties 1 required
GetCodebookResponse
object
Contains a presentation of codebook
3 properties
CreateCodebookForQuestionResponse
object
Contains a presentation of codebook
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

voxco-codebooks-api-openapi.yml Raw ↑

Other APIs Voxco publishes across the network.

Voxco AICoder API
Voxco Companies API
Voxco Exports API
Voxco Languages API
Voxco Questions API
Voxco Responses API
Voxco Sessions API
Voxco Studies API
Voxco StudyRespondents API
Voxco Users API
Where this information came from

This is an independent, third-party profile of Voxco Codebooks 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.