Skip to content

Commit f4177b1

Browse files
jancurnTC-MO
andauthored
feat: Various improvements (#1820)
This PR bundles a number of improvements to the docs, in various places, that I've done over time. --------- Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
1 parent 25d7655 commit f4177b1

File tree

18 files changed

+124
-102
lines changed

18 files changed

+124
-102
lines changed

apify-api/openapi/openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ info:
122122
```
123123
124124
However, there are a few explicitly described exceptions, such as
125-
Dataset [Get items](#/reference/datasets/item-collection/get-items) or
125+
[Get dataset items](#/reference/datasets/item-collection/get-items) or
126126
Key-value store [Get record](#/reference/key-value-stores/record/get-record)
127127
API endpoints, which return data in other formats.
128128
In case of an error, the response has the HTTP status code in the range of

apify-api/openapi/paths/actor-tasks/actor-tasks@{actorTaskId}@runs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ post:
153153
To fetch the Actor run results that are typically stored in the default
154154
dataset, you'll need to pass the ID received in the `defaultDatasetId` field
155155
received in the response JSON to the
156-
[Get items](#/reference/datasets/item-collection/get-items) API endpoint.
156+
[Get dataset items](#/reference/datasets/item-collection/get-items) API endpoint.
157157
operationId: actorTask_runs_post
158158
parameters:
159159
- name: actorTaskId

apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ post:
167167
168168
To fetch the Actor run results that are typically stored in the default
169169
dataset, you'll need to pass the ID received in the `defaultDatasetId` field
170-
received in the response JSON to the [Get items](#/reference/datasets/item-collection/get-items)
170+
received in the response JSON to the [Get dataset items](#/reference/datasets/item-collection/get-items)
171171
API endpoint.
172172
operationId: act_runs_post
173173
parameters:

apify-api/openapi/paths/datasets/datasets@{datasetId}@items.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
get:
22
tags:
33
- Storage/Datasets
4-
summary: Get items
4+
summary: Get dataset items
55
description: |
66
Returns data stored in the dataset in a desired format.
77

sources/academy/build-and-publish/actor-ideas/what_software_an_actor_can_be.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,21 @@ Examples:
3636

3737
### SaaS API wrappers
3838

39-
These Actors wrap existing SaaS services as Actors to make them accessible through the Apify platform and its many integrations.
39+
These Actors wrap existing SaaS services as Actors to make them accessible through the Apify platform and its many integrations, potentially with additional services built on top.
4040

41-
Examples:
41+
Example Actors:
4242

4343
- [OpenRouter](https://apify.com/apify/openrouter)
4444
- [Parsera](https://apify.com/parsera-labs/parsera)
4545
- [Super Scraper API](https://apify.com/apify/super-scraper-api)
4646

47+
For inspiration, see:
48+
49+
- [RapidAPI Hub](https://rapidapi.com/hub)
50+
- [Google Cloud APIs](https://cloud.google.com/apis)
51+
- [\{API\}Market](https://api.market/)
52+
- [openapi](https://openapi.com/products)
53+
4754
### Open-source libraries
4855

4956
Many open-source automation or data processing tools do not have a presence in the cloud, and need to be installed locally in "just five easy steps". Wrap those tools as Actors and make it easy for users to try and integrate those tools.
@@ -117,10 +124,16 @@ Build Actors that use LLMs to perform complex tasks autonomously. These Actors c
117124
:::note Secure execution
118125

119126
Actors are cloud-based sandboxes that can securely run any AI-generated code.
127+
As LLMs are [generally better](https://www.anthropic.com/engineering/code-execution-with-mcp)
128+
at generating code than selecting tools, one can use Actors to generate task-specific code and
129+
expose it using Actor interface to other apps and agents.
120130

121131
:::
122132

123-
For inspiration, check out the [Agents category](https://apify.com/store/categories/agents) in Apify Store.
133+
For inspiration, see:
134+
135+
- [Agents category](https://apify.com/store/categories/agents) in Apify Store
136+
- [agent.ai marketplace](https://agent.ai/)
124137

125138
### Other
126139

@@ -190,5 +203,6 @@ Beyond the [Actor ideas](https://apify.com/ideas) page, you can find new Actor i
190203
- Your experience: Draw from problems you've encountered in your work
191204
- Community discussions: Browse Reddit, Twitter, Stack Overflow, and forums for user pain points
192205
- Competitor analysis: Research existing tools and identify gaps
206+
- Other portals, such as [Indiehackers](https://www.indiehackers.com/), [Superframeworks](https://superframeworks.beehiiv.com/t/startup-ideas), etc.
193207

194208
Once you get one, learn how to [validate your Actor idea](/academy/build-and-publish/actor-ideas/actor-validation).

sources/academy/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Web Scraping Academy
2+
title: Apify Academy
33
description: Learn everything about web scraping and automation with our free courses that will turn you into an expert scraper developer.
44
sidebar_position: 0
55
slug: /

sources/academy/tutorials/api/run_actor_and_retrieve_data_via_api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ The **run info** JSON also contains the IDs of the default [dataset](/platform/s
254254

255255
> If you are scraping products, or any list of items with similar fields, the [dataset](/platform/storage/dataset) should be your storage of choice. Don't forget though, that dataset items are immutable. This means that you can only add to the dataset, and not change the content that is already inside it.
256256
257-
To retrieve the data from a dataset, send a GET request to the [**Get items**](/api/v2/dataset-items-get) endpoint and pass the `defaultDatasetId` into the URL. For a GET request to the default dataset, no token is needed.
257+
To retrieve the data from a dataset, send a GET request to the [**Get dataset items**](/api/v2/dataset-items-get) endpoint and pass the `defaultDatasetId` into the URL. For a GET request to the default dataset, no token is needed.
258258

259259
```cURL
260260
https://api.apify.com/v2/datasets/DATASET_ID/items

sources/legal/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ hide_table_of_contents: true
1010
<!-- vale off -->
1111
<!-- markdownlint-disable -->
1212

13-
## Company details (Impressum)
13+
## Legal info (Imprint)
1414

1515
**Apify Technologies s.r.o.**<br/>
1616
Registered seat: Vodickova 704/36, 110 00 Prague 1, Czech Republic<br/>

sources/legal/sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module.exports = {
22
legal: [
33
{
44
type: 'link',
5-
label: 'Company details (Impressum)',
5+
label: 'Legal info (Imprint)',
66
href: '/legal',
77
},
88
{

sources/platform/actors/development/actor_definition/input_schema/secret_input.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ If you read the `INPUT` key from the Actor run's default key-value store directl
6969
> await Actor.getValue('INPUT');
7070
{
7171
username: 'username',
72-
password: 'ENCRYPTED_VALUE:Hw/uqRMRNHmxXYYDJCyaQX6xcwUnVYQnH4fWIlKZL2Vhtq1rZmtoGXQSnhIXmF58+DjKlMZpTlK2zN3YUXk1ylzU6LfXyysOG/PISAfwm27FUgy3IfdgMyQggQ4MydLzdlzefX0mPRyixBviRcFhRTC+K7nK9lkATt3wJpj91YAZm104ZYkcd5KmsU2JX39vxN0A0lX53NjIenzs3wYPaPYLdjKIe+nqG9fHlL7kALyi7Htpy91ZgnQJ1s9saJRkKfWXvmLYIo5db69zU9dGCeJzUc0ca154O+KYYP7QTebJxqZNQsC8EH6sVMQU3W0qYKjuN8fUm1fRzyw/kKFacQ==:VfQd2ZbUt3S0RZ2ciywEWYVBbTTZOTiy'
72+
password: 'ENCRYPTED_VALUE:Hw/uqRMRNHmxXYYDJCyaQX6xcwUnVYQnH4fWIlKZL...'
7373
}
7474
```
7575

0 commit comments

Comments
 (0)