Prompt Details
Model
(claude-4-6-sonnet)
Token size
1,104
Example input
[DRAFT]: Create Customer EndpointWelcome to one of our most powerful and frequently used endpoints! This endpoint allows you to create a new customer in our system. It's designed with developer experience in mind and is one of the foundational building blocks of your integration.Use this endpoint when you need to add a new customer to your account. This is typically the first step in setting up a new user journey, and it returns a customer object that you can then use in subsequent API calls.AuthenticationOur API uses industry-standard authentication to ensure your data stays secure. You'll need to authenticate your request using your API key. Don't have an API key yet? Sign up at our developer portal to get one.RequestPOST /v1/customersParameters- email (string, required): An email address for the customer. This is used to identify the customer and send them notifications.- name (string, optional): An optional parameter that allows you to specify a display name for the customer.- metadata (object, optional): A flexible metadata object that you can use to store custom data about the customer.ExampleHere's an example of how to call this endpoint: a curl POST to /v1/customers with a Bearer token and a JSON body containing email and name.ResponseThe response will return a customer object with id, email, name, and created_at.Rate LimitsWe have rate limits in place to ensure fair usage of our API. Please keep in mind these limits as you build your integration.
Example output
POST /v1/customers
Creates a customer.
Auth: Bearer token in Authorization header. Get a key at developer.acmecorp.com.
Parameters:
- email (string, required): customer email. Used for the unique key on this customer record.
- name (string, optional): display name.
- metadata (object, optional): custom key-value pairs. <SPECIFICS NEEDED: confirm metadata constraints, e.g. max keys and value length, if any.>
Request:
\`\`\`bash
curl -X POST https://api.acmecorp.com/v1/customers \\
-H "Authorization: Bearer YOUR_API_KEY" \\
-H "Content-Type: application/json" \\
-d '{"email": "jane@example.com", "name": "Jane Smith"}'
\`\`\`
Response:
\`\`\`json
{
"id": "cus_abc123",
"email": "jane@example.com",
"name": "Jane Smith",
"created_at": "2026-05-24T10:30:00Z"
}
\`\`\`
Rate limits: <SPECIFICS NEEDED — the original said "rate limits are in place" with no numbers. State the actual limit, e.g. 100 requests/minute per API key, 429 on exceed.>
---
Changes:
- Replaced heading "Create Customer Endpoint" with "POST /v1/customers" (HTTP verb + path)
- Replaced 2-paragraph endpoint description with one imperative sentence ("Creates a customer.")
- Deleted "Welcome to one of our most powerful..." marketing preamble
- Deleted "Use this endpoint when you need to..." filler
- Replaced auth section with one sentence plus link
- Rewrote parameter descriptions in compressed form
- Deleted "Here's an example of how to call this endpoint:" preamble; kept the code block
- Flagged metadata constraints and rate-limit numbers as specifics needed
Developer-readiness verdict:
- Could a developer make a successful first call after reading the edited doc? Partial
- Missing: actual rate-limit numbers, metadata constraints, and a response error section (the original had none)
Word count before to after: 295 to 92
AI/template signal estimate before to after: high to low
Instant access
Commercial use
Money‑backBy purchasing this prompt, you agree to our terms of service
1
Favorites
1
Views
CLAUDE-4-6-SONNET
Strips the marketing fluff out of API documentation so a developer gets straight to endpoint, auth, params, request, response, and errors. Deletes the "Welcome to our powerful API" preambles, the "this endpoint allows you to" filler, and vague "reasonable rate limits" hand-waving — while preserving every code block, JSON schema, and status code verbatim. Returns the edited doc plus a verdict on whether a developer could make a successful first call. Calibrated for Claude Sonnet 4.6 and Opus 4.7.
...more
Added 2 weeks ago
