Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Companies API prompts API

The prompts API from The Companies API — 4 operation(s) for prompts.

The Companies API prompts API is one of 12 APIs that The Companies API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include prompts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.thecompaniesapi.com.

4 operations 4 paths 4 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.thecompaniesapi.com/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

The Companies API prompts API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey).

  • apiKey — The API key to use for authentication, you can get it from your API tokens page.

Paths & Operations 4

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

prompts 4
GET
/v2/prompts
Fetch prompts history.
fetchPrompts 10 params → 200401
DELETE
/v2/prompts/{promptId}
Delete a prompt.
deletePrompt 1 param → 200400401403
POST
/v2/prompts/product
Query the product prompt.
productPrompt body → 200401403
POST
/v2/prompts/segmentation
Convert a query to a segmentation.
promptToSegmentation body → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Prompt (12 properties), PaginationMeta (9 properties), LLMAnswer (7 properties), SegmentationCondition (5 properties). Each schema is shown below with its type and property counts.

LLMAnswer
object
An answer from a query made to the LLM.
7 properties 4 required
PaginationMeta
object
Metadata about a paginated or billed response.
9 properties 8 required
SegmentationCondition
object
A condition for our platform segmentation engine.
5 properties 4 required
Prompt
object
A natural language request made to the platform resolving to a specific action or search segment.
12 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thecompaniesapi-prompts-api-openapi.yml Raw ↑

Other APIs The Companies API publishes across the network.

The Companies API actions API
The Companies API analytics API
The Companies API companies API
The Companies API industries API
The Companies API job-titles API
The Companies API lists API
The Companies API locations API
The Companies API teams API
The Companies API technologies API
The Companies API users API
The Companies API utilities API