Setup project

Prerequisites and project setup for integrating with the Ctxfy API.

Overview

Before calling the Ctxfy API, you need a base URL and an API key. This guide covers minimal project setup; for step-by-step requests see Quickstart and First API Request.

Prerequisites

Base URL — Your API endpoint (e.g. https://api.ctxfy.com or your deployment).
API key — Create one in the Ctxfy dashboard or via POST /v1/api-keys. The raw key is shown only once; store it securely.

Optional: environment variables

For local or script use, set:

CTXFY_BASE_URL — API base URL (e.g. https://api.ctxfy.com).
CTXFY_API_KEY — Your API key (Bearer token).

Example .env (do not commit secrets):

CTXFY_BASE_URL=https://api.ctxfy.com
CTXFY_API_KEY=your_api_key_here

Next steps

Create a space

Call POST /v1/spaces with name and optional description. See Quickstart — Create a space.

Create a source

Add content via POST /v1/spaces/:spaceId/sources (type CONTENT, URI, or FILE). See Quickstart — Create a source.

Check status and artifacts

Use GET /v1/sources/:sourceId and GET /v1/spaces/:spaceId/artifacts. See Concepts.

For authentication details and rate limits, see Authentication.

Was this page helpful?

Last updated Feb 19, 2026

Built with Documentation.AI