Skip to content

Latest commit

 

History

History
180 lines (148 loc) · 6.09 KB

File metadata and controls

180 lines (148 loc) · 6.09 KB
title Getting Started
description Get up and running with Morphik
On a new tab, navigate to the [Morphik website](https://morphik.ai) and click the "Get Started" button on the top right.
![Sign up page](/assets/sign_up.png)
Once you have signed up, you will be redirected to the Morphik Cloud dashboard. Click the "Create Application" button to create a new application. Enter your app name and click "Create Application".
![Create application dialog](/assets/create_app.png)
You should now see your application in the dashboard with "Copy URI" and "Copy Token" buttons: - **For Python SDK**: Click "Copy URI" - **For TypeScript/API**: Click "Copy Token"
![Created application with copy buttons](/assets/created_app.png)

That's it! You're ready to use Morphik now :)

Using Morphik

While most users integrate Morphik into their applications via our SDKs and APIs, we also provide a comprehensive web interface that serves as both a playground and management console.

Morphik Web Interface

The Morphik web interface provides a complete view of your application:

Morphik Application Interface

In the web interface, you can:

  • 📄 Browse and manage all your documents and folders
  • 💬 Use the Chat and Agent for interactive queries and complex tasks
  • 🔗 Visualize Knowledge Graphs to understand document relationships
  • 📊 Monitor logs and track API usage
  • 💳 View billing and usage details for your account
  • ⚙️ Configure settings and manage your application

This interface is perfect for testing queries, debugging, and getting familiar with Morphik's capabilities before integrating it into your code.

Using Morphik via Code

For production use, you'll want to integrate Morphik using our SDKs or API:

```bash python3.12 -m venv .venv ``` ```bash source .venv/bin/activate ``` ```bash pip install morphik ``` ```python from morphik import Morphik
  # Initialize the Morphik client
  morphik = Morphik(uri="your-morphik-uri")
  # Ingest a file
  doc = morphik.ingest_file(file_path="super/complex/file.pdf")
  doc.wait_for_completion()

  # Query the file
  response = morphik.query(query="What percentage of Morphik users are building something cool?")
  print(response) # Responds with 100% :)
  ```
  </Step>
</Steps>
You can find our entire SDK documentation [here](/python-sdk/morphik).
```bash npm install morphik # or yarn add morphik ``` ```typescript import Morphik from 'morphik'; import * as fs from 'fs';
  // Initialize the Morphik client
  // Copy token from dashboard
  const morphik = new Morphik({
    apiKey: 'your-morphik-token'
  });

  // Ingest a file
  const file = fs.createReadStream('super/complex/file.pdf');
  const doc = await morphik.ingest.ingestFile({ file });
  
  // Wait for processing to complete
  await new Promise(resolve => setTimeout(resolve, 5000));

  // Query the file
  const response = await morphik.query.generateCompletion({
    query: 'What percentage of Morphik users are building something cool?'
  });
  console.log(response.completion); // Responds with 100% :)
  ```
  </Step>
</Steps>
You can find our API reference with SDK examples [here](../api-reference/getting-started).
The bearer token can be extracted directly from your Morphik URI. The URI has the following format:
  `morphik://<app_name>:<bearer_token>@<host>`
  
  The middle part between the colon and the @ symbol is your bearer token.
</Step>
<Step title="Make API requests">
  When making requests to the Morphik API, include your bearer token in the `Authorization` header:
  
  ```bash        
    curl -X 'POST' 'https://api.morphik.ai/documents?skip=0&limit=10000' \
    -H "Authorization: Bearer <your_bearer_token>"
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{}'
  ```
  
  You can find our complete API reference [here](/api-reference/getting-started).
</Step>
You can find more information about MCP [here](/using-morphik/mcp).

Community Support

We have an open community with lots of discussion where you can get help, report bugs, and share your experiences with Morphik. If you need assistance or want to contribute, please join our community!

Get help, report bugs, and connect with other Morphik users.

Next Steps

Now that you have the server running, you can explore the different ways to interact with the server.

Configure Morphik using the `morphik.toml` file. Use the API to interact with the server. Use the Python SDK to interact with the server. Use the TypeScript/JavaScript SDK to interact with the server.