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

Codehooks Documents API

CRUD operations on NoSQL collection documents

Codehooks Documents API is one of 4 APIs that Codehooks 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, and an API reference.

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

Requests are made against a single base URL, https://{projectId}.api.codehooks.io/{space}.

9 operations 4 paths 3 schemas 2 DELETE3 GET2 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{projectId}.api.codehooks.io/{space}
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Codehooks Documents API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-apikey (apiKey). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • apiKey — API key for authentication. Obtain from the Codehooks.io dashboard or CLI.
  • bearerAuth — JWT token for authentication

Paths & Operations 9

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

Documents 9

CRUD operations on NoSQL collection documents

GET
/{collection}
Codehooks List documents in a collection
listDocuments 7 params → 200401404
POST
/{collection}
Codehooks Create a new document
createDocument 1 param body → 201400401
GET
/{collection}/{id}
Codehooks Get a document by ID
getDocument 2 params → 200401404
PUT
/{collection}/{id}
Codehooks Replace a document
replaceDocument 2 params body → 200400401404
PATCH
/{collection}/{id}
Codehooks Update a document
updateDocument 2 params body → 200400401404
DELETE
/{collection}/{id}
Codehooks Delete a document
deleteDocument 2 params → 200401404
PATCH
/{collection}/_byquery
Codehooks Update multiple documents by query
updateDocumentsByQuery 2 params body → 200400401
DELETE
/{collection}/_byquery
Codehooks Delete multiple documents by query
deleteDocumentsByQuery 2 params → 200401
GET
/{collection}/_count
Codehooks Count documents in a collection
countDocuments 2 params → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed is Document (1 property). Each schema is shown below with its type and property counts.

DocumentInput
object
Input data for creating or replacing a document. Any valid JSON object is accepted.
DocumentUpdate
object
Partial update data for a document. Supports direct field updates or MongoDB-like update operators such as $set, $inc, $unset, $push, and $pull.
Document
object
A document in a Codehooks collection. Documents are schema-flexible JSON objects with a system-assigned id.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

codehooks-documents-api-openapi.yml Raw ↑

Other APIs Codehooks publishes across the network.

Codehooks Events (AsyncAPI)
Codehooks Key-Value Store API
Codehooks Queue API
Where this information came from

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