Skip to content

docs: add GET /v1/activity endpoint documentation#635

Open
firecrawl-spring[bot] wants to merge 6 commits intomainfrom
docs/activity-api
Open

docs: add GET /v1/activity endpoint documentation#635
firecrawl-spring[bot] wants to merge 6 commits intomainfrom
docs/activity-api

Conversation

@firecrawl-spring
Copy link
Contributor

Summary

  • Adds OpenAPI spec definition for GET /activity to both v1 and v2 OpenAPI specs
  • Creates endpoint doc pages (activity.mdx) for both v1 and v2
  • Adds the endpoint to the Account Endpoints navigation group in docs.json

Companion to firecrawl/firecrawl#3160

Test plan

  • Verify docs render correctly with mintlify dev
  • Confirm the Activity endpoint appears in the Account Endpoints section for both v1 and v2
  • Verify the OpenAPI spec renders the query parameters, response schema, and examples correctly

Adds OpenAPI spec and docs pages for the new activity endpoint
that lists recent API jobs with cursor-based pagination.

Co-Authored-By: micahstairs <micah@sideguide.dev>
- Rename query param from next_cursor to cursor
- Remove 403 ZDR response from OpenAPI spec
- Improve origin/integration field descriptions with real examples

Co-Authored-By: micahstairs <micah@sideguide.dev>
…er kind

- Remove origin and integration fields from OpenAPI response schema
- Add browser to kind enum in both v1 and v2 OpenAPI specs
- Add browser kind to retrieval table in docs pages

Co-Authored-By: micahstairs <micah@sideguide.dev>
- Rename `kind` query param and response field to `endpoint`
- Rename `next_cursor` response field to `cursor` to match query param
- Update descriptions accordingly

Co-Authored-By: micahstairs <micah@sideguide.dev>
- Remove search, extract, llmstxt, deep_research, map, and browser
  from activity endpoint tables and OpenAPI enum lists
- Fix v2 activity.mdx to reference /v2 retrieval endpoints instead of /v1

Co-Authored-By: micahstairs <micah@sideguide.dev>
The full endpoint list should remain in the OpenAPI enums; only the
doc tables were trimmed.

Co-Authored-By: micahstairs <micah@sideguide.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants