canonical: https://jentic.com/apis/apideck.com/proxy # Apideck Proxy API The Apideck Proxy API forwards arbitrary HTTP requests to a connector's underlying API while reusing the OAuth token and configuration that Apideck has already negotiated with the end user. Five endpoints - GET, POST, PUT, PATCH, DELETE - all on the single /proxy path expose the full HTTP surface, with the target service identified by Apideck headers and the path passed through to the upstream provider. It exists as an escape hatch when a Unified API does not cover a feature the agent or product needs to call directly. Authentication uses the Apideck Authorization header plus x-apideck-app-id; the consumer ID identifies which connection the request is forwarded over. ## For AI agents Forward arbitrary HTTP requests to any Apideck-connected provider's native API using the connection's stored OAuth token, when a Unified API does not cover the operation needed. ## Scope Does not normalise responses, set up new OAuth connections, or trigger Unified API workflows - use only as a pass-through to connector-native endpoints when a Unified API does not cover the operation. ## Capabilities - Forward a GET request to a connector's native endpoint via GET /proxy - Forward a POST request with body payload via POST /proxy - Forward PUT, PATCH, and DELETE requests for full HTTP coverage - Reuse the consumer's already-authorised OAuth token without separate auth handling - Hit any provider-specific endpoint that the matching Apideck Unified API does not yet expose - Combine Unified API calls with Proxy fallbacks in a single workflow against the same connection ## Use cases ### Provider-Specific Feature Escape Hatch When a Unified API (CRM, HRIS, Accounting, etc.) does not expose a feature a customer needs - a vendor-specific custom object, a beta endpoint, an unusual report - call the Proxy API instead. The Proxy reuses the connection's already-stored OAuth token, so the agent does not have to manage credentials separately. Useful for filling gaps without abandoning the unified integration model. Example prompt: Use POST /proxy with x-apideck-service-id 'salesforce' to call /services/data/v58.0/sobjects/CustomObject__c with a JSON body, returning the resulting record ID ### Reusing Stored OAuth Tokens Avoid building a parallel OAuth flow for the few endpoints not covered by Unified APIs. The Proxy API forwards the request using the consumer's stored token, so a product that already integrates Apideck Vault and a Unified API can extend coverage to any endpoint the connector exposes by routing through /proxy. Example prompt: Forward GET /proxy with x-apideck-service-id 'hubspot' targeting /crm/v3/properties/companies, parse the response, and return all custom property names ### Custom Report Pulls Pull a connector-specific custom report or query that has no Unified API equivalent. POST /proxy carries the request body, the upstream path, and the target service ID, and Apideck applies the connection's auth before forwarding. The response is returned unmodified, so the agent processes the upstream payload directly. Example prompt: POST /proxy with x-apideck-service-id 'quickbooks' targeting /v3/company/{realmId}/query with a SQL-like query string, return the raw upstream JSON ### AI Agent Custom Call via Jentic An AI agent needs to call a vendor-specific endpoint that no Unified API covers. Through Jentic, the agent searches 'forward request through apideck proxy', loads the matching /proxy operation, and executes it with the upstream path and body. Jentic stores the Apideck Authorization, x-apideck-app-id, and x-apideck-consumer-id headers separately so the agent never holds raw credentials. Example prompt: Through Jentic, search 'forward request through apideck proxy', load POST /proxy, set x-apideck-service-id and the upstream path, and execute the call with the supplied body ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /proxy | Forward a GET request to the connected provider | | POST | /proxy | Forward a POST request to the connected provider | | PUT | /proxy | Forward a PUT request to the connected provider | | PATCH | /proxy | Forward a PATCH request to the connected provider | | DELETE | /proxy | Forward a DELETE request to the connected provider | ## Key resources - **Proxy** — Forward GET, POST, PUT, PATCH, or DELETE requests to a connector's native API using the stored OAuth token ## Why Jentic - **Setup:** Wiring the Apideck Proxy API by hand means setting up its API key plus consumer and service headers and hand-forwarding requests to connector-native endpoints yourself. Through Jentic you install once, import Apideck Proxy from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** The Apideck Proxy API is a pass-through where the target endpoint travels in the request rather than a fixed resource path, so scope the agent to the HTTP operations it needs, such as GET and POST, and leave out DELETE unless you add it. You choose the allowed operations, so the agent only calls what you list. - **Credential handling:** Your Apideck API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'call a connector-native endpoint not covered by a unified API', and Jentic returns the matching Apideck Proxy operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Apideck Vault API** — Vault stores the OAuth tokens and connection configuration the Proxy reuses on every forwarded request. - **Apideck CRM Unified API** — CRM Unified API handles the standard CRM operations; Proxy fills gaps for vendor-specific custom objects. - **Pipedream Connect** — Pipedream Connect provides a similar managed-OAuth proxy across thousands of apps with a different trade-off (workflow runtime included). ## FAQ ### What authentication does the Apideck Proxy API use? An apiKey scheme on the `Authorization` header with your Apideck application key, plus `x-apideck-app-id` and `x-apideck-consumer-id` headers. The consumer ID identifies which connection the proxy uses, so the underlying provider's OAuth token is already stored at Apideck. Through Jentic these are stored encrypted in the vault and injected at execution. ### Can I call any endpoint on a connected provider through the Proxy API? Yes - the upstream path is passed via Apideck headers and the request body is forwarded as-is for POST, PUT, and PATCH. The Proxy supports GET, POST, PUT, PATCH, and DELETE on /proxy. Use it as a fallback when a Unified API does not cover a feature you need. ### What are the rate limits for the Apideck Proxy API? The OpenAPI spec does not publish per-endpoint rate limits. Apideck applies plan-based limits at unify.apideck.com plus the upstream provider's own limits - Proxy calls count against both. See https://developers.apideck.com for your plan's gateway quota. ### How do I forward a request through Jentic? Install with `pip install jentic`, then run the search query 'forward request through apideck proxy'. Jentic returns the matching /proxy operation (GET/POST/PUT/PATCH/DELETE) - load its schema, set the service ID and upstream path, and execute. ### When should I use the Proxy API instead of a Unified API? Use a Unified API (CRM, HRIS, POS, etc.) whenever it covers the operation - the schema is normalised across providers and the agent does not need to know vendor-specific details. Use Proxy only as an escape hatch for connector-specific endpoints, beta features, or custom objects the Unified API does not yet expose. ### Does the Proxy API normalise the response from the underlying provider? No. The response body is returned unchanged from the upstream provider - the Proxy is a pass-through. Your code or agent must parse the vendor-specific response shape. This is the trade-off for getting access to endpoints not covered by Unified APIs. ### Can I limit what my agent is allowed to do with the Apideck Proxy API? Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use with the Apideck Proxy API. Since the Proxy is a pass-through where the target endpoint travels in the request rather than a fixed path, you scope the agent to only the HTTP operations it needs, such as GET and POST, and leave out PUT, PATCH, and DELETE unless you explicitly allow them. The agent calls only the operations you list, and your Apideck key stays encrypted and is injected at execution rather than exposed to the agent.