DeepAPI

This file is a compact router. The references/ files are organized by user workflow, research, scraping, email, browser automation, image generation, and agent state, not by platform. Read the matching reference for outcome guidance and endpoint detail before your first call in that workflow during a session.

Required Environment

• Read DEEPAPI_API_BASE_URL and API_KEY from the environment.
• If either is missing, load the platform file and re-check: PowerShell . "$HOME/.deepapi/env.ps1"; bash/zsh source ~/.deepapi/env.
• If still missing, stop and ask the user to run the setup prompt from https://deepapi.co/docs.
• Never commit, print, log, paste, or expose API_KEY.

Request Rules

• Send the documented authentication credentials on every request.
• Send X-DeepAPI-Skill-Version with the managed version from VERSION.txt in this skill folder on every request. If that file is missing, use this file's frontmatter version.
• Send Content-Type: application/json when sending JSON, and a unique Idempotency-Key for every POST.
• Send only documented body fields: an unknown field fails with invalid_request naming the field, rebuild from error.fix and retry.
• Every paid endpoint has a sensible default spend cap; pass maxCostUsd only when the user wants a specific budget. Unsure about cost or balance? Add dryRun: true first, a free preview.

Picking the Right Endpoint

Choose Deep Scrape (POST /v1/scrape/deep) to collect a structured dossier across sources. Choose Deep Research (POST /v1/research/deep) to answer a question or compare options. Use website or platform scraping when the task only needs that source. Read references/scraping.md for the Deep Scrape recipe.