Skip to content

Commit 1de74f4

Browse files
authored
Add information on how to refer to resources (#440)
1 parent 6f86bc3 commit 1de74f4

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

content/docs/api_v2/api_v2_reference.apib

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,13 @@ Note that the Apify API clients [for JavaScript](https://docs.apify.com/api/apif
374374
and [for Python](https://docs.apify.com/api/apify-client-python)
375375
use the exponential backoff algorithm transparently, so that you do not need to worry about it.
376376

377+
## Referring to resources
378+
379+
There are three main ways to refer to a resource you're accessing via API.
380+
381+
- the resource ID (e.g. `iKkPcIgVvwmztduf8`)
382+
- `username~resourcename` - when using this access method, you will need to use your API token, and access will only work if you have the correct permissions.
383+
- `~resourcename` - for this, you need to use an API token, and the `resourcename` refers to a resource in the API token owner's account.
377384

378385
# Group Actors
379386

0 commit comments

Comments
 (0)