# Projects

## Look up projects

Resolve a list of project names or slugs to their canonical Sumble projects. Pass a `projects` array (1–1000 entries) and receive one entry in `results` for every input, in the same order you supplied them.

Each result pairs your original `input` with the matched `project`, or `null` when nothing matches — so the response always lines up one-to-one with your request. Use a matched project's canonical `slug` as the identifier for other API endpoints.

The response also returns `matched_count`, the number of inputs that resolved to a project.

Use this endpoint when you already have a set of project names or slugs — for example, from a spreadsheet or a prior call — and need stable, canonical identifiers to pass into follow-up requests.

### Credit cost

1 credit per 100 matched projects. Unmatched inputs do not consume credits.

## POST /v6/projects/lookup

> Look up projects by name

```json
{"openapi":"3.1.0","info":{"title":"Sumble API","version":"v6"},"servers":[{"url":"https://api.sumble.com"}],"security":[{"api_token":[]}],"components":{"securitySchemes":{"api_token":{"type":"http","scheme":"bearer"}},"schemas":{"LookupProjectsRequest":{"properties":{"projects":{"items":{"type":"string"},"type":"array","maxItems":1000,"minItems":1,"title":"Projects","description":"List of project names or slugs to look up"}},"type":"object","required":["projects"],"title":"LookupProjectsRequest"},"LookupProjectsResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"credits_used":{"type":"integer","title":"Credits Used"},"credits_remaining":{"type":"integer","title":"Credits Remaining"},"matched_count":{"type":"integer","title":"Matched Count"},"results":{"items":{"$ref":"#/components/schemas/app__schemas__paid_api__projects__LookupProjectsResponse__LookupResult"},"type":"array","title":"Results"}},"type":"object","required":["id","credits_used","credits_remaining","matched_count","results"],"title":"LookupProjectsResponse"},"app__schemas__paid_api__projects__LookupProjectsResponse__LookupResult":{"properties":{"input":{"type":"string","title":"Input"},"project":{"anyOf":[{"$ref":"#/components/schemas/ProjectDetails"},{"type":"null"}]}},"type":"object","required":["input","project"],"title":"LookupResult"},"ProjectDetails":{"properties":{"id":{"type":"integer","title":"Id"},"slug":{"type":"string","title":"Slug"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","slug","name"],"title":"ProjectDetails"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v6/projects/lookup":{"post":{"tags":["projects"],"summary":"Look up projects by name","operationId":"lookup_projects__api_version__projects_lookup_post","parameters":[{"name":"require_mcp","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Require Mcp"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupProjectsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupProjectsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sumble.com/api/projects.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.