Authentication

The Docu-analyzer API authenticates all requests using API keys.

Unauthenticated requests or requests with invalid API keys will return errors. API keys can be created and managed on the API Key Management page in your [Workspace].

Creating an API Key

Creation Process

Navigate to Workspace > API Keys
Click the 'Generate API Key' button
Immediately copy the generated API key and store it in a secure location

Important: For security reasons, the API key value cannot be retrieved again once you close this window.

API Request Method

API keys must be sent in the Authorization header using HTTP Bearer authentication.

Replace the {API_KEY} portion with your issued API key and include it in the request header.

Header Format

Authorization: Bearer {API_KEY}

cURL Request Example

curl -X POST 'https://foundry.synap.kr/api/v1/docu-analyzer/analyze' \
  -H 'Authorization: Bearer {API_KEY}' \
  -F 'file=@{FILE_PATH}' \
  -o result.zip

API Key Security

API keys are highly sensitive information, like passwords. They should never be exposed externally.

Security Guidelines

Do not share your API key with others
Never hardcode API keys in code repositories like GitHub, or in client-side code such as browsers or mobile apps
API keys should be securely loaded from server environment variables or professional key management services (KMS) such as AWS Secrets Manager or HashiCorp Vault