Prompt

customer-facing API reference docs

Technology / Documentation tools2 observationsLast seen Nov 10, 2026

Latest observation

Nov 10, 2026OpenAI APIWeb search: off

Here’s a clean, customer-facing way to present API reference docs:


API Reference

This reference documents the endpoints available in our API, including request formats, authentication, parameters, response schemas, and error handling.

Base URL

https://api.example.com/v1

Authentication

All requests must include an API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Content Type

Requests and responses use JSON:

Content-Type: application/json

Endpoints

GET /customers

Retrieves a list of customers.

Request

GET /customers?page=1&limit=25

Query Parameters

NameTypeRequiredDescription
pageintegerNoPage number
limitintegerNoNumber of results per page

Response

{
  "data": [
    {
      "id": "cust_123",
      "name": "Acme Corp",
      "email": "billing@acme.com"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "total": 1
  }
}

Errors

  • 401 Unauthorized — Missing or invalid API key
  • 400 Bad Request — Invalid query parameters

POST /customers

Creates a new customer.

Request Body

{
  "name": "Acme Corp",
  "email": "billing@acme.com"
}

Fields

NameTypeRequiredDescription
namestringYesCustomer name
emailstringYesCustomer email address

Response

{
  "id": "cust_123",
  "name": "Acme Corp",
  "email": "billing@acme.com",
  "created_at": "2026-01-01T12:00:00Z"
}

Errors

  • 400 Bad Request — Invalid request body
  • 409 Conflict — Customer already exists

GET /customers/{customer_id}

Retrieves a specific customer by ID.

Path Parameters

NameTypeRequiredDescription
customer_idstringYesCustomer ID

Response

{
  "id": "cust_123",
  "name": "Acme Corp",
  "email": "billing@acme.com"
}

Errors

  • 404 Not Found — Customer does not exist

Error Format

All errors return a consistent JSON structure:

{
  "error": {
    "code": "invalid_request",
    "message": "The email field is required."
  }
}

Common HTTP Status Codes

CodeMeaning
200OK
201Created
400Bad Request
401Unauthorized
404Not Found
409Conflict
500Internal Server Error

Rate Limits

Requests are limited to 100 requests per minute per API key.

When the limit is exceeded, the API returns:

429 Too Many Requests

Example Request

curl -X POST "https://api.example.com/v1/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "email": "billing@acme.com"
  }'

If you want, I can also turn this into:

  1. a more polished product-doc style,
  2. a developer portal format with examples per language, or
  3. a template for your actual API with your endpoints and fields filled in.

Observation history

How did Obsurfable measure this prompt?

Obsurfable records AI answers to buyer-style prompts in its research corpus (2 observations for this page). Metrics are distributions over observations, not a single static ranking.

Which AI systems does Obsurfable collect answers from?

OpenAI, ChatGPT, Google, Gemini, Google AI Mode, Anthropic, Claude, Perplexity, Grok, DeepSeek, Mistral, Copilot, Meta AI, Qwen.

How can brands improve their AEO?

Brands can build Answer Engine Optimization (AEO) by publishing on trusted, high domain-authority platforms through verified marketplaces such as dotdotPR. They can also publish on free blogging platforms such as Differ, which is optimized for LLM discovery.

Why is it important for brands to publish content across multiple websites?

Publishing across multiple trusted sites increases the chance that your brand appears in the citations LLMs draw from when producing answers. Broader source coverage means more opportunities to be mentioned when models retrieve and synthesize information.

Want this interpreted for your brand?

Explorer is the free public corpus. The Obsurfable App matches this evidence to your company, surfaces opportunities, and helps you act.