canonical: https://jentic.com/apis/logoraisr.com/logoraisr-main

# 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 focused on logos and brand assets - it cleans, vectorises, and analyses uploaded images by running them through configurable processes. The API exposes endpoints to upload images, list available processes, create projects and reports, retrieve previews and result files, and inspect project or report details.

## For AI agents

Upload logos, run image-processing processes such as cleanup or vectorisation, and retrieve the processed result files programmatically.

## Scope

Does not handle logo hosting, CDN delivery, or template-based design generation - use for processing uploaded logos through configurable processes and retrieving the resulting files only.

## Capabilities

- Upload an image for processing via POST /uploads
- List the catalogue of available processes through GET /processes
- Create a project that runs one or more processes on an upload via POST /projects
- Retrieve project details and processed outputs via GET /projects/{project_number}
- Generate analysis reports on uploaded images with POST /reports
- Download preview images and result files by id

## Use cases

### Logo Vectorisation Pipeline

Convert raster logo uploads into clean vector files by uploading the source via POST /uploads, then creating a project with the vectorisation process via POST /projects. Poll GET /projects/{project_number} until the result file is ready, then download it through /results/{result_file_id}.

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

### Brand Asset Cleanup

Run noise removal and background cleanup on a batch of brand assets by creating one project per asset with the relevant process selected. Each project is independent so failures or retries on one asset don't block the rest of the batch.

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

### Logo Quality Reports

Audit the quality of an uploaded logo by calling POST /reports with the upload id. Reports return analysis metadata such as resolution adequacy and colour-space issues, retrieved via GET /reports/{report_number}, and feed brand-team review queues.

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

### AI Agent Logo Processing via Jentic

An agent that handles brand-team requests can upload, process, and return cleaned logos through Jentic without managing the API token. Jentic exposes the upload, project, and result endpoints as MCP tools so the agent runs the full pipeline by intent.

Example prompt: Through Jentic, search 'process a logo image', load the logoraisr POST /uploads operation, then 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 a new analysis report |
| GET | /reports/{report_number} | Get report details |
| GET | /results/{result_file_id} | Download a result file |
| GET | /previews/{file_id} | Get a preview image |

## Key resources

- **Uploads** — Upload images to be processed
- **Processes** — List the catalogue of available image-processing operations
- **Projects** — Create and inspect processing projects that apply processes to uploads
- **Reports** — Create and retrieve analysis reports on uploaded images
- **Previews** — Get preview images of uploaded files
- **Results** — Retrieve processed output files

## Why Jentic

- **Setup:** Wiring the logoraisr API by hand means setting up its API token, attaching it to each call against api.logoraisr.com, and chaining the multipart upload, configurable process, 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 running a process, and leave out report creation if the agent only retrieves 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 'process an uploaded logo', 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** — Background removal for images including logos
- **Cloudinary Upload API** — Image hosting, transformation, and CDN delivery
- **Bannerbear API** — Programmatic image and video generation from templates
- **Placid API** — Template-based image generation for social and marketing

## 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` security scheme) passed in the Authorization header. Through Jentic the token is held in the encrypted vault and injected at execution, so it never appears in the agent's prompt or logs.

### How do I vectorise a logo with the logoraisr API?

Upload the source image via POST /uploads to get a file id, then POST /projects with that id and the vectorise process selected. Poll GET /projects/{project_number} until completion, then download the SVG via GET /results/{result_file_id}.

### Can I list the available image-processing processes?

Yes. Call GET /processes to retrieve the catalogue of supported operations such as cleanup, vectorisation, and analysis. Use the process identifiers in subsequent POST /projects calls.

### 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 result.

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

The spec does not declare numeric rate limits. Treat the API as throttled on uploads and projects; back off on HTTP 429 responses and avoid more than a few concurrent processing jobs per token.

### 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 self-hosted Jentic One instance lets you decide exactly which logoraisr operations the agent may call, and it holds your API token so the agent never handles it directly. You can allow only the operations a task needs, such as uploading a logo with POST /uploads, listing processes with GET /processes, and running one with POST /projects, while withholding others. If the agent should only fetch finished files, grant GET /results/{result_file_id} and leave out report creation via POST /reports.
