Get Parsing Status
Potpie API
Get Parsing Status
Check the parsing status of a specific project using its project ID. Returns the current status and whether the parsed commit matches the latest commit on the branch.
GET
Get Parsing Status
Check the current parsing status of a repository. Monitor whether parsing has completed and if the parsed version matches the latest commit on the branch.
Authentication
This endpoint requires API key authentication via thex-api-key header.
Request & Response
Request & Response
| Location | Field | Type | Required | Description |
|---|---|---|---|---|
| Path | project_id | string | required | Unique identifier of the project (returned from Parse Directory endpoint) |
| Response | status | string | - | Current parsing state: submitted, cloned, parsed, processing, inferring, ready, or error |
| Response | latest | boolean | - | Whether the parsed commit matches the latest commit on the branch |
Complete Workflow
Error Responses
401 Unauthorized
401 Unauthorized
404 Not Found
404 Not Found
The endpoint returns this error when the project doesn’t exist or you lack access permissions.Causes:
- The
project_iddoesn’t exist in the database - You are not the project owner
- The project is not shared with your account
- The project was deleted
project_id is correct and ensure you have appropriate access permissions.500 Internal Server Error
500 Internal Server Error
The endpoint returns this error when unexpected exceptions occur during status retrieval.Causes:
- Database connection failures
- Unexpected data format issues
- Service unavailability
project_id.Troubleshooting
Status stuck at 'submitted'
Status stuck at 'submitted'
Problem: Status remains at ‘submitted’ for an extended period.Solution:
- The parsing queue might be busy. Wait a few minutes and check again
- If it persists for more than 5 minutes, contact support with your project ID
- Very large repositories may take longer to begin processing
Status shows 'error'
Status shows 'error'
Problem: Parsing failed to complete.Solution:
- Verify the repository is accessible
- Check that the branch exists
- Ensure the repository structure is valid
- Consider that very large repositories may timeout
- Contact support if the issue persists
latest field is false
latest field is false
Problem: The
latest field shows false even though status is ready.Solution:- This indicates the branch has new commits since parsing
- Re-parse the repository to get the latest code analysis
- This is expected behavior for active branches with ongoing development
Status Phases
During parsing, you’ll see different status values corresponding to analysis stages:| Status | Description | Typical Duration |
|---|---|---|
submitted | Parsing request queued | Immediate |
cloned | Repository cloned successfully | 10-30 seconds |
parsed | Code structure analyzed | 1-5 minutes |
processing | Building knowledge graph | 5-15 minutes |
inferring | Generating knowledge graph inferences | 5-20 minutes |
ready | Parsing complete and ready | Final state |
error | Parsing failed | Final state |
Authorizations
API key authentication. Get your key from potpie settings page
Path Parameters
The unique project identifier returned from the parse endpoint

