CaptureKit

Analyze (AI)

GET
/v1/analyze

AI Content API analyzes any webpage and returns AI insights summary, value proposition, features, categories, use cases, and optional contact signals.

Credit cost: 1 credit per call

Authorization

ApiKeyAuth
x-api-key<token>

Your API key. Include it in the x-api-key header for every request.

In: header

Query Parameters

url*string

The URL of the webpage to capture.

custom_response?string

Pass custom response fields to be included in the AI response.

This can be provided in two ways: As a JSON object in the request body As a JSON stringified object in the query parameters

Example:

{	"sentiment": "sentiment",    "language": "language"}
custom_prompt?string

Add your own instructions to guide the AI’s analysis.

proxy?string

Specify a proxy server to route your request through.

Supports HTTP, HTTPS, and SOCKS5 proxies.

Format: http://username:password@proxy.com:PORT.

Useful for bypassing geo-restrictions and rotating IPs.

cache?boolean

Cache the response.

Default"false"
cache_ttl?number

Cache the response for a custom TTL (in seconds).

Range3600 <= value <= 2592000
Default"2592000"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/analyze?url=string"
{  "data": {    "emails": [      "admin@company.com"    ],    "summary": "Tailwind CSS is a utility-first CSS framework for modern web design.",    "useCases": [      "Building websites",      "Customizing themes",      "Managing CSS specificity"    ],    "categories": [      "Web Development",      "CSS Frameworks",      "Frontend Development",      "Responsive Design"    ],    "keyFeatures": [      "Responsive design",      "Dark mode",      "Animations",      "Grid layout"    ],    "phoneNumbers": [      "+13322767084"    ],    "targetAudience": "Web developers and designers.",    "valueProposition": "A flexible CSS framework packed with utility classes."  },  "success": true}
{  "error": "Bad Request"}
{  "error": "Invalid API Key"}
{  "error": "Payment required"}
{  "error": "Rate limit exceeded for the API key: quota monthly"}
{  "error": "Internal Error"}