Codehooks API

Name: Codehooks API
Brand: Codehooks API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCloud InfrastructureServerlessapiKey12 EndpointsREST

For Agents

Read and write documents, key-value pairs, and queue items in a Codehooks.io serverless backend using an x-apikey header.

Install Jentic One Beta

Connect the Codehooks API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Codehooks API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Codehooks API.

Create, query, replace, patch, and delete documents in any Codehooks collection via /{collection} endpoints

Set, fetch, and delete arbitrary key-value pairs through /kv/{key}

Enqueue background jobs by posting to /queue/{name}

GET STARTED

Start building with Codehooks API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Codehooks API, keeping it validated and agent-ready. Codehooks.io is a serverless backend-as-a-service that bundles a NoSQL document store, key-value store, queues, scheduled jobs, and serverless JavaScript or TypeScript functions behind a single API. The runtime API exposes 12 endpoints for collection CRUD, key-value operations, queue inserts, project info, and log streaming, all scoped to a project under a space-specific subdomain. Authentication is an x-apikey header issued per project, and the data API doubles as the storage layer for any Codehooks-deployed function.

Use Cases

Patterns agents use Codehooks API for, with concrete tasks.

★ Lightweight Backend for an MVP

Use Codehooks as the entire backend for an MVP — collections store user and product data, the KV store holds feature flags, and queues coordinate background work. Front-end clients call /{collection} for CRUD without standing up a separate database, ORM, or hosting tier. Cuts time-to-first-user from weeks to a single afternoon.

Provision an 'orders' collection by POSTing a sample document to /orders, then read it back with GET /orders to confirm persistence

Background Job Orchestration via Queues

Move long-running work — email sends, PDF generation, third-party syncs — into Codehooks queues so user-facing requests stay fast. The agent calls POST /queue/{name} to enqueue jobs, and a Codehooks function consumes them asynchronously. Replaces ad hoc setTimeout patterns and gives jobs visible retry semantics.

POST {to: 'alice@example.com', template: 'welcome'} to /queue/email-send and confirm the response includes the queued message id

Configuration and Feature Flag Storage

Use the key-value store as a remote configuration and feature flag store for client apps. The agent writes flags via PUT /kv/{key} and clients read via GET /kv/{key} with a short cache. Avoids redeploying the front-end every time a flag flips while keeping the storage stack inside the same Codehooks project.

PUT {value: true} to /kv/feature.checkout-v2 and verify GET /kv/feature.checkout-v2 returns true

Operational Log Inspection

Pull recent logs from a Codehooks project to debug a misbehaving function without leaving the agent loop. GET /_log returns the latest entries, which the agent can filter by severity and timestamp before posting a triage summary to the developer. Saves a context switch into the Codehooks dashboard.

Call GET /_log, filter to severity=error in the last 30 minutes, and summarise the top three error messages

Agent-Driven Backend Operations via Jentic

An AI agent connected to Jentic can run end-to-end Codehooks workflows — read a document, enqueue a job, write a flag — in a single intent. Jentic stores the project x-apikey in its vault and resolves the space-specific base URL so the agent only specifies the operation. The raw API key never enters agent context.

Search Jentic for 'create Codehooks document', execute POST /{collection}=customers, then enqueue a follow-up via POST /queue/onboarding-email

Key Endpoints

12 endpoints — jentic publishes the only available openapi specification for codehooks api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/{collection}

Query documents in a collection

POST

/{collection}

Create a document

PATCH

/{collection}/{id}

Partially update a document

DELETE

/{collection}/{id}

Delete a document

GET

/kv/{key}

Get a key-value pair

PUT

/kv/{key}

Set a key-value pair

POST

/queue/{name}

Enqueue an item

GET

/_log

Get application logs

GET

/{collection}

Query documents in a collection

POST

/{collection}

Create a document

PATCH

/{collection}/{id}

Partially update a document

DELETE

/{collection}/{id}

Delete a document

GET

/kv/{key}

Get a key-value pair

PUT

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Codehooks x-apikey values are stored encrypted in the Jentic vault per project. Agents receive scoped execution access; the raw key never enters agent context, and rotation can happen centrally without redeploying agents.

Intent-based discovery

Agents search Jentic by intent (e.g., 'insert a Codehooks document' or 'enqueue a Codehooks job') and Jentic returns the matching operation with parameter schema, so the agent can call /{collection} or /queue/{name} without scraping vendor docs.

Time to first call

Direct Codehooks integration: half a day to wire the space-specific base URL, x-apikey auth, and error handling. Through Jentic: under 20 minutes — search, load, execute.

FAQs

Specific to using Codehooks API through Jentic.

Why is there no official OpenAPI spec for Codehooks API?

Codehooks.io does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Codehooks API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Codehooks API use?

The Codehooks API uses an API key in the x-apikey header. Generate the key inside the Codehooks CLI or dashboard and scope it per project. Through Jentic the key is stored in the vault and never enters agent context.

Can I run queries against a Codehooks collection?

Yes. GET /{collection} accepts query parameters that filter documents by field equality, ranges, and pagination. The endpoint returns a JSON array, so an agent can iterate over results without hitting individual /{collection}/{id} endpoints.

What are the rate limits for the Codehooks API?

Codehooks does not publish a fixed public rate limit; limits depend on the plan tier of the project. Treat the API as best-effort and back off on HTTP 429 responses. For high-throughput inserts, use queues so the runtime can absorb bursts.

How do I enqueue a background job through Jentic?

Search Jentic for 'add item to Codehooks queue', load the POST /queue/{name} schema, and execute it with the queue name and payload. Jentic injects the x-apikey from the vault and returns the queued message id.

Can I deploy serverless functions through this API?

No. Function deployment happens through the Codehooks CLI, not the runtime API. This spec covers the data plane — collections, key-value pairs, queues, project info, and logs. Functions you deploy via CLI then read and write through these same endpoints.

Codehooks API

Connect the Codehooks API to your agent

Capabilities

Start building with Codehooks API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs