Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ab7fa81

Browse files
committed
Revamped the Collaboration section
1 parent 937e86f commit ab7fa81

File tree

3 files changed

+74
-106
lines changed

3 files changed

+74
-106
lines changed

docs/agent-collaboration/data-pool/custom-storage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Advanced users can use the `API Call` component to communicate directly with Pin
5050
To configure:
5151

5252
- Add your Pinecone API key from the **Vault**
53-
- Use endpoint URLs from [Pinecone's API reference](https://docs.pinecone.io/reference)
53+
- Use endpoint URLs from [Pinecone's API reference](https:/docs.pinecone.io/reference)
5454
- Pass headers, payloads, and parameters manually
5555

5656
<WarningCallout title="Vector dimension must be 1536">
Lines changed: 19 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,40 @@
11
---
2-
title: Export / Import Agents
3-
description: Quickly test, validate, and import API calls using Postman in your SmythOS workflow.
4-
keywords: [postman, export agent, import collection, api testing, smythos postman integration]
5-
toc_max_heading_level: 2
2+
title: Postman Integration
3+
description: Export agents to Postman or import Postman collections into SmythOS for quick API testing and integration.
4+
keywords: [postman, smythos integration, export agent, import collection, api testing]
65
sidebar_position: 9
76
---
87

9-
# How to Export / Import Agents via Postman
8+
# Postman Integration: Export Agents and Import Collections
109

11-
Use Postman to test your agent’s endpoints or import external APIs into SmythOS.
10+
Use Postman to test SmythOS agent endpoints or import external APIs into your workflows.
1211

1312
<Spacer size="md" />
1413

15-
## Export to Postman
14+
## Export Agents to Postman
1615

17-
- Go to your agent in the Team Dashboard
18-
- Click the three-dot menu and choose <code>Export to Postman</code>
19-
- Choose one of the following options:
20-
21-
- **Test Endpoint Collection**
22-
- Uses the test subdomain
23-
- Best for local testing or debugging
24-
25-
- **Prod Endpoint Collection**
26-
- Available only after deployment
27-
- Uses the production subdomain
28-
- Recommended for live monitoring or staging
29-
30-
- Import the downloaded JSON file into Postman
16+
1. In **Team Dashboard**, open your agent.
17+
2. Click the **three-dot menu****Export to Postman**.
18+
3. Choose a collection:
19+
- **Test**: uses test subdomain, for local testing/debugging.
20+
- **Prod**: available after deployment, uses production subdomain, for staging/monitoring.
21+
4. Import the JSON file into Postman.
3122

3223
<Arcade src="https://demo.arcade.software/CI0fMYdVuulWQlXdLHHo?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Export Agent to Postman | SmythOS" />
3324

3425
<Spacer size="md" />
3526

36-
## Import Postman Collection
37-
38-
Use this to bring external API definitions into your agent.
27+
## Import Postman Collections
3928

40-
- Go to the <code>Builder</code> view
41-
- Drag your Postman collection file into the canvas
42-
- SmythOS will:
43-
- Automatically convert each request into an <code>API Call</code> component
44-
- Preserve methods, headers, and payloads
29+
1. In the **Builder** view, drag your Postman JSON file onto the canvas.
30+
2. SmythOS converts each request into an **API Call** component, preserving methods, headers, and payloads.
4531

4632
<Arcade src="https://demo.arcade.software/GTrFqGZF3az6Z128wTrU?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Import Postman Collection | SmythOS" />
4733

4834
<Spacer size="md" />
4935

50-
## Notes
36+
## Tips
5137

52-
- Only supports JSON Postman format (v2.x recommended)
53-
- Use descriptive names for requests to keep imported nodes organized
54-
- You can update URLs and tokens directly inside the imported component
38+
- Only Postman JSON format is supported (v2.x recommended).
39+
- Use clear request names for better organization.
40+
- Update URLs and tokens directly in imported components.
Lines changed: 54 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,82 @@
11
---
22
title: Collaboration
3-
description: Build, share, and manage agents as a team. Use Project Spaces, a secure Vault, and role-based permissions to collaborate securely and efficiently.
4-
keywords: [collaboration, teams, sharing, permissions, roles, vault, projects, spaces]
3+
description: Work together in SmythOS using Spaces, the Vault, and role-based permissions. Share agents, manage data, and collaborate securely in real time.
4+
keywords: ["SmythOS collaboration", "Spaces", "Vault", "roles and permissions", "Data Pool", "Chat with Agent", "Analytics", "share agents", "team workflows"]
55
sidebar_position: 1
66
---
77

88
# Agent Collaboration
99

10-
In SmythOS you can build and run agents on your own or with others.
11-
Collaboration features give you a shared place to organise projects, control access, and connect agents to the resources they need.
10+
Great agents don’t happen in isolation. SmythOS makes it simple for teams to **build, share, and run agents together** while keeping credentials safe and projects organized.
1211

13-
<InfoCallout title="Quick start">
14-
Create a [Space](/docs/agent-collaboration/spaces/), add your team, set [roles](/docs/account-management/user-management), and store any credentials in the [Vault](/docs/agent-studio/key-concepts/vault).
12+
<InfoCallout title="In one line">
13+
Create a [Space](/docs/agent-collaboration/spaces/), invite your team, store keys in the [Vault](/docs/agent-studio/key-concepts/vault), and collaborate with agents in real time.
1514
</InfoCallout>
16-
<Spacer size="md" />
1715

18-
## How Collaboration Works in SmythOS
16+
<Spacer size="md" />
1917

20-
A [space](/docs/agent-collaboration/spaces/) is the main workspace for teamwork.
21-
It holds your agents, data, workflows, and settings.
22-
Within a space you can:
18+
## Why Collaboration Matters
2319

24-
- Keep each project or client separate
25-
- Invite and remove members at any time
26-
- Control exactly what each person can do
27-
- Chat with agents and test ideas together in real time
20+
Agents become more powerful when they’re connected to shared data, tested by multiple people, and managed with clear roles.
21+
SmythOS gives you the structure to do that without losing control:
2822

29-
[Permissions](/docs/account-management/user-management) are role-based and set per space.
30-
This keeps sensitive work protected while allowing others to contribute where needed.
31-
<Spacer size="md" />
23+
- Keep client or project work separated into **[Spaces](/docs/agent-collaboration/spaces/)**
24+
- Control access with **[Roles and Permissions](/docs/account-management/user-management)**
25+
- Secure API keys in the **[Vault](/docs/agent-studio/key-concepts/vault)**
26+
- Share knowledge through the **[Data Pool](/docs/agent-collaboration/data-pool/data-spaces)**
27+
- Work directly with agents using **[Chat with Agent](/docs/agent-collaboration/chat-with-agent)**
28+
- Monitor usage and costs with **[Analytics](/docs/account-management/user-management)**
29+
- Export, share, or [move agents across projects](/docs/agent-collaboration/sharing-agents)
30+
- Apply your own [branding with White Labeling](/docs/agent-collaboration/spaces/white-labeling)
3231

33-
## Main Tools for Teamwork
32+
This creates a single place where your whole team can work confidently, whether you’re a startup, an agency, or an enterprise.
3433

35-
| Tool | Purpose | Best For |
36-
|------|---------|----------|
37-
| **[Spaces](/docs/agent-collaboration/spaces/)** | Create separate environments for agents, data, and members | Agencies, multi-project teams |
38-
| **[Vault](/docs/agent-studio/key-concepts/vault)** | Encrypted storage for API keys and secrets | Any team using third-party services |
39-
| **[Roles & Permissions](/docs/account-management/user-management)** | Set what each member can view or change | Teams with mixed responsibilities |
40-
| **[Sharing & Exporting](/docs/agent-collaboration/sharing-agents)** | Share agents or import/export workflows | Distributed or partner teams |
41-
| **[White Labeling](/docs/agent-collaboration/spaces/white-labeling)** | Apply your own branding per space | Client-facing or reseller workspaces |
34+
<Image
35+
src="/docs/img/agent_collaboration/agent-collaboration.png"
36+
alt="Agent dashboard in a SmythOS Space showing shared agents, data, and collaboration tools"
37+
caption="Work together in a Space to manage agents, share resources, and keep everything organized in one dashboard."
38+
/>
4239

4340
<Spacer size="md" />
44-
## Setting Up Your First Collaborative Project
4541

46-
1. **Create a space**
47-
Go to the [Spaces page](/docs/agent-collaboration/spaces/) and click **Create Space**.
48-
Give it a clear name, choose the right branding if needed, and decide who will join.
49-
You can add members now or later.
42+
## Core Building Blocks
5043

51-
2. **Invite your team**
52-
Use [Invite Members](/docs/agent-collaboration/spaces/invite-members) or add them when [sharing an agent](/docs/agent-collaboration/sharing-agents).
44+
| Building Block | What It Does | Why It Matters |
45+
|----------------|--------------|----------------|
46+
| **[Spaces](/docs/agent-collaboration/spaces/)** | Project-based workspaces for agents, data, and teammates | Keep projects separate but easy to manage |
47+
| **[Roles & Permissions](/docs/account-management/user-management)** | Assign Viewer, Editor, Admin, or Super Admin | Stay secure while enabling collaboration |
48+
| **[Vault](/docs/agent-studio/key-concepts/vault)** | Encrypted key and secret storage | Share API credentials safely across agents |
49+
| **[Data Pool](/docs/agent-collaboration/data-pool/data-spaces)** | Shared datasets and knowledge sources | Give agents collective memory |
50+
| **[Chat with Agent](/docs/agent-collaboration/chat-with-agent)** | Real-time collaboration and testing | Explore, debug, and iterate together |
51+
| **[Analytics](/docs/account-management/user-management)** | Track token usage and costs | Stay in control of performance and spend |
52+
| **[Sharing & Exporting](/docs/agent-collaboration/sharing-agents)** | Move workflows between projects | Flexible handoff and portability |
53+
| **[White Labeling](/docs/agent-collaboration/spaces/white-labeling)** | Apply custom branding to spaces | Perfect for client-facing work |
5354

54-
3. **Assign roles**
55-
Choose `Viewer`, `Editor`, `Admin`, or `Super Admin` based on what each person needs to do.
56-
See the [Roles and Permissions guide](/docs/account-management/user-management) for details.
55+
<Spacer size="md" />
56+
57+
## How to Get Started
5758

58-
4. **Add credentials to the Vault**
59-
This lets agents connect to services like OpenAI or Google without exposing the keys.
59+
1. **[Create a Space](/docs/agent-collaboration/spaces/)** → Organize your first project or client.
60+
2. **[Invite Teammates](/docs/agent-collaboration/spaces/invite-members)** → Add members and assign roles.
61+
3. **[Assign Roles](/docs/account-management/user-management)** → Decide who can view, edit, or deploy.
62+
4. **[Secure Credentials in the Vault](/docs/agent-studio/key-concepts/vault)** → Store API keys safely for shared use.
63+
5. **[Add Data to the Pool](/docs/agent-collaboration/data-pool/data-spaces)** → Give agents a shared knowledge base.
64+
6. **[Collaborate with Agents](/docs/agent-collaboration/chat-with-agent)** → Test and debug in real time.
65+
7. **[Track Analytics](/docs/account-management/user-management)** → Monitor usage, performance, and costs.
6066

61-
5. **Start building and testing together**
62-
Use [Team Spaces Chat](/docs/agent-collaboration/spaces/team-spaces-chat) or [Chat with Agent](/docs/agent-collaboration/chat-with-agent) to collaborate in real time.
67+
<TipCallout title="Next step">
68+
Head over to [Spaces](/docs/agent-collaboration/spaces/) and set up your first collaborative project.
69+
</TipCallout>
6370

6471
<Spacer size="md" />
6572

66-
## Where to Go Next
73+
## Explore Collaboration Features
6774

6875
<CardGrid>
69-
<Card
70-
title="Spaces"
71-
description="Create and manage secure workspaces for your agents and data."
72-
to="/docs/agent-collaboration/spaces/"
73-
/>
74-
<Card
75-
title="Invite Members"
76-
description="Add people to your space and assign roles."
77-
to="/docs/agent-collaboration/spaces/invite-members"
78-
/>
79-
<Card
80-
title="Roles and Permissions"
81-
description="Understand and configure role-based access."
82-
to="/docs/account-management/user-management"
83-
/>
84-
<Card
85-
title="The Vault"
86-
description="Store and share API keys without exposing them."
87-
to="/docs/agent-studio/key-concepts/vault"
88-
/>
89-
<Card
90-
title="Sharing & Exporting"
91-
description="Share agents with others or move workflows between tools."
92-
to="/docs/agent-collaboration/sharing-agents"
93-
/>
94-
<Card
95-
title="White Labeling"
96-
description="Apply your own branding to a space."
97-
to="/docs/agent-collaboration/spaces/white-labeling"
98-
/>
76+
<Card title="Spaces" description="Create and manage workspaces for your agents and data." to="/docs/agent-collaboration/spaces/" />
77+
<Card title="Roles and Permissions" description="Understand and configure role-based access." to="/docs/account-management/user-management" />
78+
<Card title="Data Pool" description="Build shared knowledge bases for your agents." to="/docs/agent-collaboration/data-pool/data-spaces" />
79+
<Card title="Chat with Agent" description="Collaborate and test in real time." to="/docs/agent-collaboration/chat-with-agent" />
80+
<Card title="Analytics" description="Track usage and costs for each project." to="/docs/account-management/user-management" />
81+
<Card title="Sharing & Exporting" description="Share agents or move workflows between tools." to="/docs/agent-collaboration/sharing-agents" />
9982
</CardGrid>
100-

0 commit comments

Comments
 (0)