Skip to main content

Publishing and sharing

A new actor is private: only your account sees and runs it. You can share it with chosen people or organizations, or publish it to the Store so every Lantfly account can find and run it.

Before you publish​

Make the actor's page complete. People decide from it whether to run your actor.

FieldWhereTips
title, description.actor/actor.json or the ConsoleA clear name and one sentence about what it returns.
readmeConsole or APIWhat the actor does, the input, an example of the output, limits and costs. Markdown.
input_schema.actor/input_schema.jsonTitles, descriptions and defaults for every field. See Input schema.
example_inputConsole or APIA small input that works.
dataset_schema.actor/dataset_schema.jsonA table view of the results.
categoriesConsole or APIFor example developer-tools, automation, social-media.
default_optionsConsole or APIDefault memory_mb and timeout_secs for runs.
pricingConsole or APIOptional. See Monetization.

Publish to the Store​

Turn on Public on the actor in the Console, or set is_public:

Publish the actor
curl -X PATCH "https://lantfly.com/api/v3/actors/<username>~my-actor" \
-H "Authorization: Bearer $LANTFLY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"is_public": true,
"readme": "# My Actor\n\nPushes items to its dataset.",
"categories": ["developer-tools"],
"example_input": {"count": 3}
}'

A public actor appears in the Store (GET /api/v3/actors lists what an account can run; search, category and sort filter it). Runs of a public actor belong to, and are billed to, the account that runs them.

To retire an actor without breaking callers at once, set is_deprecated: true. To take it out of the Store, set is_public: false.

Share a private actor​

Share an actor with a person (by email) or an organization (by account id). They can see and run it; their runs are theirs and billed to them.

Share with a person
curl -X POST "https://lantfly.com/api/v3/actors/<username>~my-actor/shares" \
-H "Authorization: Bearer $LANTFLY_TOKEN" \
-H "Content-Type: application/json" \
-d '{"email": "[email protected]", "access": "run"}'
TaskAPI
List sharesGET /api/v3/actors/{actor}/shares
SharePOST /api/v3/actors/{actor}/shares with email or account_id, and access: "run"
RevokeDELETE /api/v3/actors/{actor}/shares/{share}

Revoking refuses new runs at once; runs that already started finish. You cannot share a public actor or share with your own account (422). In an organization, owners and admins manage shares.

Reviews​

Accounts that ran a public actor can review it: 1 to 5 stars, a title and a text. Each account (personal or organization) writes one review per actor and can edit or delete it.

  • An account needs at least one finished run of the actor (a run that succeeded or was charged).
  • You cannot review your own actor, or an actor of an account you are a member of.
  • A new review is published as verified, or held as pending for moderation.
TaskAPI
Read reviews and rating statsGET /api/v3/actors/{actor}/reviews (sort: newest, highest, lowest; rating; per_page)
Write or edit your reviewPUT /api/v3/actors/{actor}/review with rating, title, content
Delete your reviewDELETE /api/v3/actors/{actor}/review
Reply as the actor's ownerPUT /api/v3/actors/{actor}/reviews/{review}/reply with content (one reply per review, editable)
Remove your replyDELETE /api/v3/actors/{actor}/reviews/{review}/reply

You get a notification when someone reviews your actor, and the reviewer gets one when you reply.

Quality score​

The Store sorts actors by a quality score from 0 to 100 by default (other sorts: popular, rating, newest). It is computed every night from the last 30 days:

PartWeightWhat counts
Reliability40%Share of succeeded runs (failed and timed-out runs count against it; aborted runs are ignored). Runs of your own account do not count, and each other account counts for at most 10 runs.
Ratings25%Average stars, smoothed so a few reviews do not swing it.
Maintenance15%How recent the last successful build or version is: full score within 30 days, down to zero at a year. A deprecated actor gets zero.
Paying users20%How many other accounts paid for runs.

New actors start near the middle. Keep your actor building, fix failures quickly and answer reviews.

Monthly summary​

On the first day of each month, owners of public actors get an email with the previous month's runs, distinct accounts, failure rate and new reviews per actor.