Skip to content

docs(social): authenticated Scraper Results polling + scrape persistence note (chat#1840) #262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sweetmantech wants to merge 2 commits into from
Closed

docs(social): authenticated Scraper Results polling + scrape persistence note (chat#1840) #262

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8493a9f
docs(social): account-scoped Scraper Results auth + scrape persistenc…
sweetmantech Jul 3, 2026
4ac7067
rework: any authenticated caller can poll scraper runs (chat#1840 dec…
sweetmantech Jul 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api-reference/openapi/social.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,7 @@
},
"/api/apify/runs/{runId}": {
"get": {
"description": "Check the status and retrieve results from Apify scraper runs. This endpoint uses the Apify API Client to fetch the current status of a scraper run and its results if available. Use the runId returned from endpoints like Instagram Comments, Instagram Profiles, Social Scrape, or Artist Socials Scrape to poll for results.",
"description": "Check the status and retrieve results from Apify scraper runs. This endpoint uses the Apify API Client to fetch the current status of a scraper run and its results if available. Use the runId returned from endpoints like Instagram Comments, Instagram Profiles, Social Scrape, or Artist Socials Scrape to poll for results. Requires authentication: any valid API key or Bearer token can poll any run id — scrape results are public social content and run ids are unguessable, so possession of a runId plus a valid credential is sufficient.",

@cubic-dev-ai cubic-dev-ai Bot Jul 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1: The GET /api/apify/runs/{runId} endpoint description says "Requires authentication: any valid API key or Bearer token can poll any run id" but the endpoint has no security field. Other authenticated endpoints in this file (e.g., GET /api/artists/{id}/posts, GET /api/connectors) explicitly declare security: [{ "apiKeyAuth": [] }, { "bearerAuth": [] }]. Without a security declaration, the OpenAPI spec tells consumers that this endpoint accepts unauthenticated requests, contradicting both the description and the new contract.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At api-reference/openapi/social.json, line 485:

<comment>The GET /api/apify/runs/{runId} endpoint description says "Requires authentication: any valid API key or Bearer token can poll any run id" but the endpoint has no `security` field. Other authenticated endpoints in this file (e.g., GET /api/artists/{id}/posts, GET /api/connectors) explicitly declare `security: [{ "apiKeyAuth": [] }, { "bearerAuth": [] }]`. Without a `security` declaration, the OpenAPI spec tells consumers that this endpoint accepts unauthenticated requests, contradicting both the description and the new contract.</comment>

<file context>
@@ -482,7 +482,7 @@
     "/api/apify/runs/{runId}": {
       "get": {
-        "description": "Check the status and retrieve results from Apify scraper runs. This endpoint uses the Apify API Client to fetch the current status of a scraper run and its results if available. Use the runId returned from endpoints like Instagram Comments, Instagram Profiles, Social Scrape, or Artist Socials Scrape to poll for results. Authorization is account-scoped: the account that started the run via the [Social Scrape](/api-reference/social/scrape) endpoint (or an admin) can poll it. Runs started by other accounts return 403; run ids with no recorded owner — including runs started before ownership tracking existed and runs started from other endpoints — return 404 for non-admin callers.",
+        "description": "Check the status and retrieve results from Apify scraper runs. This endpoint uses the Apify API Client to fetch the current status of a scraper run and its results if available. Use the runId returned from endpoints like Instagram Comments, Instagram Profiles, Social Scrape, or Artist Socials Scrape to poll for results. Requires authentication: any valid API key or Bearer token can poll any run id — scrape results are public social content and run ids are unguessable, so possession of a runId plus a valid credential is sufficient.",
         "parameters": [
           {
</file context>

"parameters": [
{
"name": "runId",
Expand Down Expand Up @@ -538,7 +538,7 @@
},
"/api/socials/{id}/scrape": {
"post": {
"description": "Trigger a social profile scraping job for a given social profile. Use the [Get Artist Socials](/api-reference/artists/socials) endpoint first to retrieve the social profile id values. The response returns run metadata for polling status and retrieving results via the [Scraper Results API](/api-reference/apify/scraper).",
"description": "Trigger a social profile scraping job for a given social profile. Use the [Get Artist Socials](/api-reference/artists/socials) endpoint first to retrieve the social profile id values. The response returns run metadata for polling status and retrieving results via the [Scraper Results API](/api-reference/apify/scraper). Completed runs also persist the scraped profile stats (follower/following counts, avatar, bio) to the social row, and on Instagram, TikTok, and X/Twitter the scraped post URLs are saved and appear in [Get Artist Posts](/api-reference/posts/get).",
"parameters": [
{
"name": "id",
Expand Down