canonical: https://jentic.com/apis/logoraisr.com/logoraisr-api-docs

# Logoraisr API docs | logoraisr.com

Jentic publishes the only available OpenAPI specification for API docs | logoraisr.com, keeping it validated and agent-ready. Logoraisr is an image-processing service for logos and brand assets that runs uploaded images through configurable processes such as vectorisation, cleanup, and analysis. The API exposes ten operations covering uploads, the process catalogue, project management, analysis reports, and retrieval of preview and result files.

## For AI agents

Upload logos, run image-processing processes, and download the resulting cleaned, vectorised, or analysed files via the logoraisr API.

## Scope

Does not handle logo hosting, CDN delivery, or template-based design generation - use for running processing operations on uploaded logo images only.

## Capabilities

- Upload an image for processing through POST /uploads
- List the catalogue of available processes via GET /processes
- Create a project that runs a process on an upload via POST /projects
- Retrieve project status and outputs via GET /projects/{project_number}
- Generate analysis reports for an upload using POST /reports
- Download processed result files by id from /results/{result_file_id}

## Use cases

### Logo Vectorisation Workflow

Convert raster logos to clean vectors. Upload via POST /uploads, create a project against the vectorise process via POST /projects, and download the SVG via /results/{result_file_id} once the project is complete.

Example prompt: POST /uploads with the PNG, POST /projects with the upload id and vectorise process, then GET /projects/{project_number}.

### Brand Asset Cleanup

Run cleanup processes on noisy or off-spec brand assets. Each project handles one asset so failures are isolated and retries are simple. The result file id surfaces in the project payload once processing finishes.

Example prompt: POST /uploads then POST /projects with process='cleanup' and the upload id.

### Logo Quality Analysis Report

Audit a logo against quality standards via POST /reports. Reports identify resolution and colour-space issues; retrieve them with GET /reports/{report_number} to feed brand-team review.

Example prompt: POST /reports with the upload id, then GET /reports/{report_number} to read the audit.

### AI Agent Logo Pipeline via Jentic

An agent that responds to design-team requests can run upload, project, and report endpoints in sequence to deliver a cleaned logo and an audit summary, without managing the API token.

Example prompt: Through Jentic, search 'process a logo', load logoraisr POST /uploads, chain POST /projects, and GET /projects/{project_number}.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /uploads | Upload a new image |
| GET | /processes | List available processes |
| POST | /projects | Create a new project |
| GET | /projects/{project_number} | Get project details |
| POST | /reports | Create an analysis report |
| GET | /reports/{report_number} | Get report details |
| GET | /results/{result_file_id} | Download a processed file |
| GET | /previews/{file_id} | Get a preview of an uploaded file |

## Key resources

- **Uploads** — Upload images for processing
- **Processes** — List the catalogue of available processes
- **Projects** — Create and inspect processing projects
- **Reports** — Create and retrieve analysis reports
- **Previews** — Get preview images of uploaded files
- **Results** — Download processed output files

## Why Jentic

- **Setup:** Wiring logoraisr by hand means setting up its API token, attaching it to each call against api.logoraisr.com, and chaining the multipart upload, process, project, and result requests yourself. Through Jentic you install once, import logoraisr from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** logoraisr creates projects and reports through request bodies rather than an account id in the URL path, so scoping is by operation: limit the agent to the operations it needs, such as uploading a logo and starting a process, and leave out report creation if the agent only produces result files.
- **Credential handling:** Your logoraisr API token 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 'vectorise a logo' or 'run a logo process', and Jentic returns the matching logoraisr operation with its multipart upload schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **remove.bg API** — Single-purpose background removal for images and logos
- **Cloudinary Upload API** — Image hosting, transformation, and CDN delivery
- **Bannerbear API** — Template-based image and video generation
- **Placid API** — Template-based programmatic image generation

## FAQ

### Why is there no official OpenAPI spec for API docs | logoraisr.com?

Logoraisr does not publish a maintained OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call API docs | logoraisr.com via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the logoraisr API use?

Logoraisr uses a token-based API key (the `Token` scheme) passed in the Authorization header. Through Jentic the token is encrypted at rest in the vault and injected at execution time, so the agent never sees the raw value.

### How do I vectorise a logo?

Upload the source image via POST /uploads, then POST /projects with the returned upload id and the vectorise process. Poll GET /projects/{project_number} until the result file id is available, then download via /results/{result_file_id}.

### Can I see what processes are available?

Yes. GET /processes returns the catalogue of supported operations along with the identifiers you pass to POST /projects when creating a job.

### How do I generate a logo quality report through Jentic?

Run `pip install jentic`, search Jentic for 'analyse a logo image', load the logoraisr POST /reports operation, and execute it with the upload id. Then load GET /reports/{report_number} to fetch the analysis.

### What are the rate limits for the logoraisr API?

Numeric rate limits are not embedded in the spec. Treat upload and project endpoints as throttled and back off on HTTP 429 responses.

### Can I limit what my agent is allowed to do with the logoraisr API?

Yes. Because logoraisr scopes access by operation rather than by an account id in the URL, your own self-hosted Jentic One instance lets you decide exactly which operations the agent may call. Your rules can grant only the endpoints it needs, such as POST /uploads and POST /projects to run a process, while leaving out report creation via POST /reports if the agent only retrieves result files. You control which operations and which stored credentials the agent is permitted to use, so it can never call an operation you have not allowed.